Base elements

Topic elements

The base topic elements include elements that make up the core building blocks of the DITA topic, such as topic, body, and related-links, as well as elements like <p> and <ph> that are used in many topic specializations. Some of these elements are also available inside the <topicmeta> map element.

Basic topic elements

The basic topic elements provide the structural framework for a topic: title, short description, prolog, body, and related links.

<abstract>

An abstract summarizes the content of the topic; it appears at the start of the topic. It can contain multiple short descriptions, as well as block-level content such as paragraphs, lists, and tables.

Usage information

The <abstract> element is designed for use in the following circumstances:

  • The initial paragraph of a topic contains lists, tables, or other block-level elements that are not permitted in the content model of <shortdesc>.
  • Only a portion of the content of the initial paragraph is suitable for a link preview or hover text.
  • A topic needs to contain multiple short descriptions, to facilitate conditional processing.

When the initial paragraph is suitable as a link preview, authors should simply place the content in a <shortdesc> element rather than in an <abstract> element.

Rendering expectations

When a contained <shortdesc> occurs within phrase-level content, processors treat it as phrase-level content and do not create a separate paragraph when the topic is rendered. When the contained <shortdesc> occurs as a peer to paragraph-level content, processors treat it as block-level content and create a separate paragraph when the topic is rendered. When multiple <shortdesc> elements are included in an <abstract>, they are concatenated when used for link previews or link summaries (separated by spaces).

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <shortdesc> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<topic>

Zero or more of the following

Contained by

Inheritance

- topic/abstract

The <abstract> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <abstract> element can be used.

Example 1. <abstract> with phrase-level short description

The following code sample shows an <abstract> element that contains a short description, as well as additional phrase-level content:

<abstract>
  <shortdesc>
      Use the wonderful Widget to automatically vacuum your house.
  </shortdesc> It requires a 1800 lithium ion battery.
</abstract>

While the complete content of the <abstract> element is rendered as the first paragraph of the topic, only the content of the <shortdesc> element is used for a link preview and hover text.

Example 2. <abstract> with block-level short description

The following code sample shows an <abstract> element that contains a short description, as well as additional block-level content: 

<abstract>
  <shortdesc>
      You have many options for arranging lodging in Brussels: hotels, bed and
      breakfasts, youth hostels, and flats. You can select from a wide price range.
  </shortdesc>
  <p>The following table explains the symbols that are used to indicate the price
     categories of the lodging options:</p>
  <simpletable>
    <! -- ... -->
  </simpletable>
</abstract>
Example 3. <abstract> with multiple short descriptions

The following code sample shows an <abstract> element that contains multiple short descriptions, which will be filtered when the topic is processed:

<abstract>
  <shortdesc platform="free-version">
      The free version of the platform provides a single e-mail list, storage 
      for up to one gigabyte of files, and will support up to 100 users.
  </shortdesc>
  <shortdesc platform="premium-version">
      The premium version of the platform provides multiple e-mails lists, 
      storage for up to 30 gigabytes of files, and will support up to 400 users.
  </shortdesc>
</abstract>

<body>

The body contains the main content of a topic.

Content model

( <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> | <bodydiv> | <section> )*

Contained by

<topic>

Zero or more of the following

Contained by

Inheritance

- topic/body

The <body> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a DITA topic that contains a title and a body:

<topic id="styleguide-bold">
  <title>Acme style guide: <xmlelement>b</xmlelement> element</title>
  <body>
    <p>Use the bold tag for visual emphasis only. Do not use it if another 
       phrase-level element better signifies the reason for the emphasis.
    </p>
  </body>
</topic>

<bodydiv>

A body division is a grouping of sequential elements within the body of a topic. There is no additional semantic meaning. It is useful primarily for reuse and as a specialization base.

Usage information

The <bodydiv> element is often used to group a sequence of related elements for reuse, so that another topic can reference the entire set with a single @conref or @conkeyref attribute.

The <bodydiv> element can nest itself, which makes it a good specialization base for general topic content. Because the <bodydiv> element allows <section>, it cannot be used within <section> elements. Use the <div> element to group content that might occur in both topic bodies and sections.

The <bodydiv> element cannot contain a title. If a title is required, use nested topics.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> | <bodydiv> | <section> )*

Contained by

<body> , <bodydiv>

Zero or more of the following

Contained by

Inheritance

- topic/bodydiv

The <bodydiv> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how the <bodydiv> element can be used to group a sequence of elements for reuse:

<body>
  <bodydiv id="mp-23475">
    <p>The maintenance pack includes the following items:</p>
    <ul>
      <li>Gloves</li>
      <li>Small screwdriver</li>
      <li>Part #23475</li>
    </ul>
  </bodydiv>
  <!-- ... -->
</body>

<dita>

The <dita> element is the root element for the ditabase document type.

Usage information

The ditabase document type is a container topic that can manage any sequence of any type of topic. It can be used to hold elements designed for reuse, and it is also useful as an intermediate output for conversion operations.

The <dita> element cannot be specialized. Topic nesting rules can be configured in the document-type shell.

Attributes

The following attributes are available on this element: @xmlns:ditaarch, @DITAArchVersion, and localization attributes.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@dir

Identifies or overrides the text directionality. The following values are valid:

lro
Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into left-to-right mode.
ltr
Indicates left-to-right.
rlo
Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into right-to-left mode.
rtl
Indicates right-to-left.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The dir attribute for more information.

@disposition
Specifies the status of the draft comment.
@DITAArchVersion (architectural attributes)
Specifies the version of the DITA architecture that is in use. This attribute is in the namespace http://dita.​oasis-open.​org/​architecture/​2005/. This attribute is specified in the topic and map modules, and it uses a default value of the current version of DITA. The current default is 2.0.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate
Specifies whether the content of the element should be translated. The following values are valid: yes, no, and -dita-use-conref-target.

See Element-by-element recommendations for translators for suggested processing defaults for each element.

@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@xml:lang
Specifies the language and optional locale of the content that is contained in an element. Valid values are language tokens or the null string. The @xml:lang attribute and its values are described in the Extensible Markup Language 1.0 specification, fifth edition.
@xmlns:ditaarch (architectural attributes)
Declares the default DITA namespace. This namespace is declared as such in the RNG modules for <topic> and <map>, but it is specified as an attribute in the equivalent DTD-based modules. The value is fixed to http://dita.​oasis-open.​org/​architecture/​2005/.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a ditabase document that contains multiple topics. The <concept>, <reference>, and <task> elements are all specializations of <topic>.

<dita>
  <concept id="batintro">
    <title>Intro to bats</title>
    <conbody>
      <!-- ... -->
    </conbody>
  </concept>
  <task id="batfeeding">
    <title>Feeding a bat</title>
    <taskbody>
      <!-- ... -->
    </taskbody>
  </task>
  <reference id="batparts">
    <title>Parts of bats</title>
    <refbody>
      <!-- ... -->
    </refbody>
  </reference>
      <!-- ... -->
</dita>

<prolog>

The prolog contains metadata about the topic, for example, author information or subject category.

Content model

( <titlealt> | <navtitle> | <searchtitle> | <linktitle> | <subtitle> | <titlehint> )*, <author> *, <source> ?, <publisher> ?, <copyright> *, <critdates> ?, <permissions> ?, <metadata> *, <resourceid> *, ( <data> | <sort-as> | <foreign> )*

Contained by

<topic>

In order
  1. Zero or more of the following
  2. Zero or more <author>
  3. Optional <source>
  4. Optional <publisher>
  5. Zero or more <copyright>
  6. Optional <critdates>
  7. Optional <permissions>
  8. Zero or more <metadata>
  9. Zero or more <resourceid>
  10. Zero or more of the following

Contained by

Inheritance

- topic/prolog

The <prolog> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a <prolog> element that contains common metadata items:

<prolog>
  <author>Paul Norman</author>
  <copyright>
    <copyryear year="1930"/>
    <copyrholder>Paul Norman</copyrholder>
  </copyright>
</prolog>

<shortdesc>

A short description is a sentence or group of sentences that describes the purpose or main point of the topic.

Usage information

When present in topics, the short description is the first paragraph of the topic. It can also be used for hover text, link previews, search results, and more.

When present in maps, the <shortdesc> element is associated with <topicref> elements. This enables map authors to accomplish the following goals:

  • Associate a short description with a non-DITA object
  • Provide a short description that is specific to the map context and used for link previews

When a <shortdesc> element applies to an entire DITA map, it serves only as a description. DITA architects might use such a <shortdesc> element to store information about the purpose of the DITA map.

Rendering expectations

Processors SHOULD render the content of the <shortdesc> element as the initial paragraph of the topic.

When processors generate link previews that are based on the map context, they SHOULD use the content of the <shortdesc> that is located in the map rather than the <shortdesc> that is located in the DITA topic. However, when processors render the topic itself, they SHOULD use the content of the <shortdesc> element that is located in the DITA topic.

Processing expectations

When a <shortdesc> element occurs in a DITA map, it overrides the short description provided in the topic for the purpose of generating map-based link previews. It does not replace the <shortdesc> in the rendered topic itself. This means that generated map-based links to this topic will use the short description from the map for any link previews provided with the link, while the rendered topic continues to use the short description located in the topic.

Content model

(Text | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <cite> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> | <image> | <xref> )*

Contained by

<abstract> , <topic>

Zero or more of the following

Contained by

Inheritance

- topic/shortdesc

The <shortdesc> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <shortdesc> element can be used.

Example 4. Short description in a topic

The following code sample shows how a <shortdesc> element can be used in a topic:

<topic id="intro-to-bird-calling">
  <title>Introduction to bird calling</title>
  <shortdesc>If you want to attract more birds to your Acme Bird Feeder, learn the art of 
      bird calling. Bird calling is an efficient way to alert more birds to the presence of 
      your bird feeder.
  </shortdesc>
 <body>
   <!-- ... -->
 </body>
</topic>
Example 5. Short description in a map

The following code sample shows how a short description can be used in a DITA map to provide information about a non-DITA resource. The content of the <shortdesc> element is used when a link preview to the Web site for the American Birding Association is generated.

<map>
  <title>Enjoying birds</title>
    <topicref href="birds-in-colorado.dita"/>
    <topicref href="bird-calling.dita"/>
    <topicref href="https://www.birding.example.com/" format="external" type="html">
      <topicmeta>
        <shortdesc>The American Birding Association is the only organization 
            in North America that specifically caters to recreational birders.
            Its mission is to "inspire all people to enjoy and protect wild birds."
        </shortdesc>
      </topicmeta>
    </topicref>
</map>

<title>

A title is a heading or label for an object. Titles can be associated with topics, maps, sections, examples, figures, tables, and other structures.

Content model

(Text | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <cite> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> | <image> )*

Contained by

<data> , <example> , <fig> , <figgroup> , <linklist> , <section> , <simpletable> , <table> , <topic>

Zero or more of the following

Contained by

Inheritance

- topic/title

The <title> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: ID and conref attributes, localization attributes, @base, @class, @outputclass, and @rev.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@base
Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

The @base attribute takes a space-delimited set of values. However, when serving as a container for generalized attributes, the attribute values will be more complex. See Attribute generalization for more details.

@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@class (not for use by authors)
This attribute is not for use by authors. If an editor displays @class attribute values, do not edit them. Specifies a default value that defines the specialization ancestry of the element. Its predefined values allow DITA tools to work correctly with specialized elements. In a generalized DITA document the @class attribute value in the generalized instance might differ from the default value for the @class attribute for the element as given in the DTD or schema. See The class attribute rules and syntax for more information. This attribute is specified on every element except for the <dita> container element. It is always specified with a default value, which varies for each element.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@conaction
Specifies how the element content will be pushed into a new location. The following values are valid:
mark
The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter
Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore
Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace
Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See Pushing reusable content to a new location for examples and details about the syntax.

@conkeyref
Specifies a key name or a key name with an element ID that acts as an indirect reference to reusable content. The referenced content is used in place of the content of the current element. See Indirect key-based content reuse for more details about the syntax and behaviors.
@conref
Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See Direct URI-based content reuse for examples and details about the syntax.
@conrefend
Specifies a URI that references the last element in a sequence of elements, with the first element of the sequence specified by @conref. The referenced sequence of elements is used in place of the content of the current element. See Reusing a range of elements for examples and details about the syntax.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@dir

Identifies or overrides the text directionality. The following values are valid:

lro
Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into left-to-right mode.
ltr
Indicates left-to-right.
rlo
Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into right-to-left mode.
rtl
Indicates right-to-left.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The dir attribute for more information.

@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@id
Specifies an identifier for the current element. This ID is the target for references by @href and @conref attributes and for external applications that refer to DITA or LwDITA content. This attribute is defined with the XML data type NMTOKEN, except where noted for specific elements within the language reference.

See id attribute for more details.

@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a role that the element is playing. The role must be consistent with the basic semantic and expectations for the element. In particular, the @outputclass attribute can be used for styling during output processing; HTML output will typically preserve @outputclass for CSS processing.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rev
Specifies a revision level of an element that identifies when the element was added or modified. It can be used to flag outputs when it matches a run-time parameter. It cannot be used for filtering nor is it sufficient to be used for version control. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate
Specifies whether the content of the element should be translated. The following values are valid: yes, no, and -dita-use-conref-target.

See Element-by-element recommendations for translators for suggested processing defaults for each element.

@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@xml:lang
Specifies the language and optional locale of the content that is contained in an element. Valid values are language tokens or the null string. The @xml:lang attribute and its values are described in the Extensible Markup Language 1.0 specification, fifth edition.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how titles are used for both the topic and a figure within the topic:

<topic id="topicid">
  <title>Monitoring your heart rate</title>
  <body>
    <!-- ... -->
    <fig>
      <title>Adjusting your monitor</title>
      <p>If the monitor is not reporting, follow the directions
         in the video to adjust your equipment.</p>
      <!-- ... -->
    </fig>
  </body>
</topic>

<titlealt>

An alternative title is used to convey information about a document in contexts other than straightforward display.

Usage Information

Alternative titles can be used in both maps and topics:

  • When used in the <topicmeta> of a root <map> element, the alternative title applies to the map itself.
  • When used inside a <topicref> element, the alternative title applies to the resource that is referenced by the <topicref> element.
  • When the referenced resource is a DITA topic, the alternative titles from the <topicref> element are merged with those authored directly in the topic, with the alternative titles from the <topicref> element taking higher priority.

The roles of an alternative title are specified by the @title-role attribute. Multiple roles can be specified, separated by white space. An alternative title specifies at least one role. Other tokens for the @title-role attribute can be defined for specific purposes.

Some roles might not be meaningful in certain contexts. For example, a navigational alternate title is not meaningful in the context of a <topicgroup> element, since the element is not part of the navigation structure of a publication. Such alternate titles are ignored by processors.

The base DITA vocabulary contains an alternative titles domain that contains convenience elements that are equivalent to <titlealt> elements with the @title-role attribute set to the tokens outlined in Processing expectations.

Processing expectations
The processing of an alternative title depends on its roles. Processors SHOULD support the following tokens for the @title-role attribute:
linking
Specifies that the content of the <titlealt> element contains the title for use in references to the resources generated from DITA map structures, such as hierarchical parent/child/sibling links and links generated from relationship tables. In addition, this is the fallback alternative title for navigation and search roles. Custom title roles meant for use in link generation should also use this as a fallback.
navigation
Specifies that the content of the <titlealt> element contains the title for use in tables of content and other navigation aids. In some cases, when processing a <topicref> that has no @href, this is also used as the title of the generated topic, if applicable. If not present, this role is fulfilled by the linking role.
search
Specifies that the content of the <titlealt> element contains a title for use in search results for systems that support content search. If not present, this role is fulfilled by the linking role.
subtitle
Specifies that the content of the <titlealt> element contains a subtitle for the document.
hint
Specifies that the content of the <titlealt> element contains a hint about the referenced resource. This is intended for the benefit of map authors; it does not have an effect on processing or output.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

Alternative titles with the @title-role attribute set to tokens that are not recognized by the processor SHOULD be ignored and not appear in output.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <draft-comment> | <required-cleanup> )*

Contained by

<prolog>

Zero or more of the following

Contained by

Inheritance

- topic/titlealt

The <titlealt> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @title-role.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@title-role (REQUIRED)
Specifies the role that the alternative title serves. Multiple roles are separated by white space. The following roles are defined in the specification: linking, navigation, search, subtitle, and hint.

Processors can define custom values for the @title-role attribute.

@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <titlealt> element can be used.

Example 6. Subtitles

The following code sample shows how a map can specify a subtitle for a publication:

<map>
  <title>Publication title</title>
  <topicmeta>
    <titlealt title-role="subtitle">Publication subtitle</titlealt>
  </topicmeta>
</map>

An identical result could be achieved by using the <subtitle> element that is provided by the alternative titles domain.

Example 7. Multiple alternative titles and their roles

The following code sample shows how a topic reference can specify several alternative titles:

<topicref keys="about" href="about.dita">
  <topicmeta>
    <titlealt title-role="linking navigation">About the product</titlealt>
    <titlealt title-role="search">About</titlealt>
    <titlealt title-role="hint">About the Acme TextMax 5000</titlealt>
  </topicmeta>
</topicref>
  1. "About the product" will be used for both linking and navigation titles, for example, when generating related links and rendering a table of contents.
  2. "About" will be used for a search title, for example, when providing a title in systems that support dynamic content searches.
  3. "About the Acme TextMax 500" provides a hint to map authors as to the contents of the referenced DITA resource. This title is not used in output.

If the alternative-titles domain is available, the following markup would be equivalent:

<topicref keys="about" href="about.dita">
  <topicmeta>
    <linktitle>About the product</navtitle>
    <searchtitle">About</searchtitle>
    <titlehint>About the Acme TextMax 5000</titlehint>
  </topicmeta>
</topicref>

<topic>

A topic is a standalone unit of information.

Content model

<title> , ( <shortdesc> | <abstract> )?, <prolog> ?, <body> ?, <related-links> ?, <topic> *

Contained by

<topic>

In order
  1. <title>
  2. Optionally one of the following
  3. Optional <prolog>
  4. Optional <body>
  5. Optional <related-links>
  6. Zero or more <topic>

Contained by

Inheritance

- topic/topic

The <topic> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: architectural attributes and universal attributes.

For this element, the @id attribute is required.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@DITAArchVersion (architectural attributes)
Specifies the version of the DITA architecture that is in use. This attribute is in the namespace http://dita.​oasis-open.​org/​architecture/​2005/. This attribute is specified in the topic and map modules, and it uses a default value of the current version of DITA. The current default is 2.0.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@id
For this element, the @id attribute is required.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@specializations (architectural attributes)
Specifies the attribute-domain specializations that are included in the document-type shell. This attribute is set as a default within the document-type shell. The value varies depending on what domains are integrated into the document-type shell. For example, a grammar file that includes the specialized attributes @audience, @deliveryTarget, and @newBaseAtt would set the value to @props/audience @props/deliveryTarget @base/newBaseAtt.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows the primary structural components of a topic: title, short description, prolog, body, and related links:

<topic id="topic">
  <title>The basic structure of a topic</title>
  <shortdesc>A topic has a well-established structure. </shortdesc>
  <prolog>
  <!-- Metadata can be stored here.-->
  </prolog>
  <body>
    <p>A typical topic contains a title, short description, and body.</p>
  </body>
     <related-links>
       <!--Related links can be defined directly in a topic or by using 
           a relationship table.--></related-links>
</topic>

Body elements

The body elements support the most common types of content for topics: paragraphs, lists, phrases, figures, and other common document components.

<alt>

Alternate text is a textual description of an image. Systems often render the alternate text when the reader is using assistive technology or the image cannot be rendered.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <draft-comment> | <required-cleanup> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> )*

Contained by

<hazardsymbol> , <image>

Zero or more of the following

Contained by

Inheritance

- topic/alt

The <alt> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how alternate text is associated with an image of a marketing banner:

<image href="newCampaign.jpg">
  <alt>Marketing banner for new product campaign</alt>
</image>

<cite>

A citation is the name or the title of a bibliographic resource, for example, a document, online article, or instructional video.

Rendering expectations

The content of the <cite> element is typically rendered in a way that distinguishes it from the surrounding text.

Content model

(Text | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <b> , <bodydiv> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <li> , <line-through> , <lines> , <linkinfo> , <lq> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <section> , <shortdesc> , <sli> , <stentry> , <strong> , <sub> , <sup> , <title> , <tt> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/cite

The <cite> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how the <cite> element can be used to mark up the title of an article:

<p>The online article <cite>Specialization in the Darwin Information Typing
Architecture</cite> provides a detailed explanation of how to define new
topic types.</p>

<dd>

The definition description is the definition for an item in a definition list entry.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<dlentry>

Zero or more of the following

Contained by

Inheritance

- topic/dd

The <dd> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <dl>.

<ddhd>

A definition heading is an optional heading or title for descriptions or definitions in a definition list.

Content model

(Text | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <cite> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> | <image> )*

Contained by

<dlhead>

Zero or more of the following

Contained by

Inheritance

- topic/ddhd

The <ddhd> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <dlhead>.

<desc>

A description is a statement that describes or contains additional information about an object.

Usage information

The following list outlines common uses of the <desc> element:

<table> and <fig>
Provides more information than can be contained in the title
<xref> and <link>
Provides a description of the target
<object>
Provides alternate content to use when the context does not permit the object to be displayed
Rendering expectations

When used in conjunction with <fig> or <table> elements, processors SHOULD consider the content of <desc> elements to be part of the content flow.

When used in conjunction with <xref> or <link> elements, processors often render the content of <desc> elements as hover help or other forms of link preview.

Content model

(Text | <dl> | <div> | <imagemap> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <ol> | <p> | <pre> | <sl> | <ul> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<audio> , <fig> , <link> , <linklist> , <object> , <table> , <video> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/desc

The <desc> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <desc> element can be used.

Example 8. Description of a figure

In the following code sample, the <figure> element contains a reference to an image of a famous painting by Leonardo da Vinci. The <title> element provides the name of the painting, while the <desc> element contains information about when the portrait is thought to have been painted.

<fig>
  <title>Mona Lisa</title>
  <desc>Circa 1503–06, perhaps continuing until 1517</desc>
  <image href="mona-lisa.jpg">
    <alt>Photograph of Mona Lisa painting</alt> 
  </image>
</fig>
Example 9. Description of a cross reference

In the following code sample, the <link> element contains a <desc> element. Some processors might render the content of the <desc> element as hover help.

<link keyref="dita-13-02">
  <linktext>DITA 1.3 Errata 02</linktext>
  <desc>Final errata version of DITA 1.3, published 19 June 2018</desc>
</link>

<div>

A division is a grouping of contiguous content within a topic. There is no additional semantic meaning.

Usage information

The <div> element is useful primarily for reuse and as a specialization base.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <li> , <linkinfo> , <lq> , <note> , <p> , <section> , <stentry>

Zero or more of the following

Contained by

Inheritance

- topic/div

The <div> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In the following code sample, a <div> element is used to organize several elements together so that they can be referenced by @conref or @conkeyref:

<div id="rendered-table">
  <p>The following screen capture shows one way the code sample might be rendered:</p>
  <image keyref="rendered-table" placement="break"/>
</div>

Without using a <div> element, the content could not be grouped for content referencing since the start and end elements are of different types.

<dl>

A definition list is a list of items and their corresponding definitions.

Rendering expectations

A definition list is typically rendered in the following way:

  • The definition term is located against the starting margin of the page or column.
  • The definition description is indented. It is located either on the same line as the definition term, or it is placed on the next line.
  • The optional header content is located on a line before the definition list entries.
Content model

( <data> | <sort-as> )*, <dlhead> ?, <dlentry> +

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <li> , <linkinfo> , <lq> , <note> , <p> , <section> , <stentry>

In order
  1. Zero or more of the following
  2. Optional <dlhead>
  3. One or more <dlentry>

Contained by

Inheritance

- topic/dl

The <dl> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @compact.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@compact
Specifies whether the vertical spacing between list items is tightened. The following values are valid: yes, no, and -dita-use-conref-target. Some DITA processors or output formats might not support the @compact attribute.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how a definition list can be used to describe the message levels that are generated by a monitoring application. The @compact attribute instructs processors to tighten the vertical spacing.

<dl compact="yes">
  <dlentry>
    <dt>Warning</dt>
    <dd>Problems were detected, but the software will continue to monitor activity.</dd>
  </dlentry>
  <dlentry>
    <dt>Error</dt>
    <dd>Problems were detected, and the software is in danger of shutting down.</dd>
  </dlentry>
  <dlentry>
    <dt>Severe</dt>
    <dd>Monitoring activity has ceased.</dd>
  </dlentry>
</dl>

<dlentry>

A definition list entry is a group within a definition list. It contains an item and its definitions.

Content model

<dt> +, <dd> +

Contained by

<dl>

In order
  1. One or more <dt>
  2. One or more <dd>

Contained by

Inheritance

- topic/dlentry

The <dlentry> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <dl>.

<dlhead>

A definition list heading is a group that contains a heading for items and a heading for definitions within the list.

Content model

<dthd> ?, <ddhd> ?

Contained by

<dl>

In order
  1. Optional <dthd>
  2. Optional <ddhd>

Contained by

Inheritance

- topic/dlhead

The <dlhead> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a definition list with a header:

<dl>
  <dlhead>
    <dthd>Image selection</dthd>
    <ddhd>Resulting information</ddhd>
  </dlhead>
  <dlentry>
    <dt>File Type</dt>
    <dd>The file extension of the image</dd>
  </dlentry>
  <dlentry>
    <dt>Image class</dt>
    <dd>Whether the image is raster, vector, or 3D</dd>
  </dlentry>
  <dlentry>
    <dt>Fonts</dt>
    <dd>Names of the fonts contained within a vector image</dd>
  </dlentry>
</dl>

Rendering of definition lists will vary by application and by display format.

<draft-comment>

A draft comment is content that is intended for review and discussion, such as questions, comments, and notes to reviewers. This content is not intended to be included in production output.

Rendering expectations

By default, processors SHOULD NOT render <draft-comment> elements. Processors SHOULD provide a mechanism that causes the content of the <draft-comment> element to be rendered in draft output only.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> )*

Contained by

<abstract> , <alt> , <b> , <body> , <bodydiv> , <cite> , <data> , <dd> , <ddhd> , <desc> , <div> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <i> , <keyword> , <li> , <line-through> , <lines> , <linkinfo> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <term> , <title> , <titlealt> , <titlehint> , <tt> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/draft-comment

The <draft-comment> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@author
Designates the originator of the draft comment.
@disposition
Specifies the status of the draft comment.
@time
Specifies when the draft comment was created.

For this element, the @translate attribute has a default value of no.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate
For this element, the @translate attribute has a default value of no.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code samples shows how a content developer can use a <draft-comment> element to pose a question to reviewers. Note that the @author and @time attributes are used to provide information who created the draft comment and when it was created.

<draft-comment author="EBP" time="23 May 2017">
  <p>Where's the usage information for this section?</p>
</draft-comment>

Processors might render the information from the highlighted attributes at viewing or publishing time. Authors might use the value of the @disposition attribute to track the work that remains to be done on a content collection.

<dt>

A definition term is the item that is defined in a definition list entry.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> | <image> )*

Contained by

<dlentry>

Zero or more of the following

Contained by

Inheritance

- topic/dt

The <dt> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <dl>.

<dthd>

A definition term heading is an optional heading or title for the items in a definition list.

Content model

(Text | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <cite> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> | <image> )*

Contained by

<dlhead>

Zero or more of the following

Contained by

Inheritance

- topic/dthd

The <dthd> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <dlhead>.

<example>

An example illustrates the subject of the topic or a portion of the topic.

Usage information

For maximum flexibility in creating specializations, examples allow plain text as well as phrase and block level elements. Because of the way XML grammars are defined within a DTD, any element that allows plain text cannot restrict the order or frequency of other elements. As a result, the <example> element allows <title> to appear anywhere as a child of <example>. However, the intent of the specification is that <title> only be used once in any <example>, and when used, that it precede any other text or element content.

Rendering expectations

Processors SHOULD treat the presence of more than one <title> element in a <example> element as an error.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <title> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <div> , <draft-comment> , <entry> , <fig> , <figgroup> , <fn> , <li> , <lq> , <note> , <p> , <section> , <stentry>

Zero or more of the following

Contained by

Inheritance

- topic/example

The <example> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows an <example> element that contains a code block and a textual explanation of it:

<section id="AddingRecord">
  <title>ADD</title>
  <p>New database records are created using the <cmdname>ADD</cmdname> command.</p>
  <example>
    <p>The following example illustrates the creation of a new record. All parameter settings 
       are strictly optional.</p>
    <codeblock>01 OPTIONS ABC,ADD,DEF,HIJK,LMNO,AOW=25000,HF=2</codeblock>
  </example>
</section>

<fallback>

Fallback content is content to be presented when multimedia objects or included content cannot be rendered.

Processing expectations

The contents of this element are displayed only when the media that is referenced by the containing element cannot be displayed or viewed.

Content model

(Text | <dl> | <div> | <imagemap> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <ol> | <p> | <pre> | <sl> | <ul> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<audio> , <include> , <object> , <video>

Zero or more of the following

Contained by

Inheritance

- topic/fallback

The <fallback> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <audio> and <video>.

<fig>

A figure is a container for a variety of objects, including artwork, images, code samples, equations, and tables.

Usage information

A <fig> element enables associating other elements, such as a title or description, with the contents of the <fig> element.

Content model

<title> ?, <desc> ?, ( <figgroup> | <audio> | <dl> | <div> | <imagemap> | <example> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <sl> | <ul> | <video> | <data> | <sort-as> | <fn> | <foreign> | <include> | <simpletable> | <xref> )*

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <div> , <draft-comment> , <entry> , <example> , <fn> , <li> , <lq> , <note> , <p> , <section> , <stentry>

In order
  1. Optional <title>
  2. Optional <desc>
  3. Zero or more of the following

Contained by

Inheritance

- topic/fig

The <fig> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: display attributes and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@expanse (display attributes)
Specifies the horizontal placement of the element. The following values are valid:
column
Indicates that the element is aligned with the current column margin.
page
Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
spread
Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
textline
Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

For <table>, in place of the @expanse attribute that is used by other DITA elements, the @pgwide attribute is used in order to conform to the OASIS Exchange Table Model.

Some processors or output formats might not support all values.

@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@frame (display attributes)
Specifies which portion of a border surrounds the element. The following values are valid:
all
Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
bottom
Indicates that a line is rendered at the bottom of the containing element.
none
Indicates that no lines are rendered.
sides
Indicates that a line is rendered at the left and right of the containing element.
top
Indicates that a line is rendered at the top of the containing element.
topbot
Indicates that a line is rendered at the top and bottom of the containing element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

Some processors or output formats might not support all values.

@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

Specifies the percentage by which fonts are resized in relation to the normal text size. The value of this attribute is a positive integer. When used on <table> or <simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.

This attribute is primarily useful for print-oriented display. Some processors might not support all values.

If the @scale attribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the <image> element.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how a <fig> element can associate a title and a description with an image:

<fig>
  <title>The handshake</title>
  <desc>This image shows two hands clasped in a formal, business-like handshake.</desc>
  <image href="59j0p66.jpg">
    <alt>A handshake</alt>
  </image>  
</fig>

<figgroup>

A figure group is a grouping of segments within a figure.

Usage information

The <figgroup> element is useful primarily as a base for complex specializations, such as nestable groups of syntax within a syntax diagram. The <figgroup> element can nest. It can also contain multiple cross-references, footnotes, and keywords.

Content model

<title> ?, ( <figgroup> | <audio> | <dl> | <div> | <imagemap> | <example> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <sl> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <fn> | <foreign> | <required-cleanup> )*

Contained by

<fig> , <figgroup>

In order
  1. Optional <title>
  2. Zero or more of the following

Contained by

Inheritance

- topic/figgroup

The <figgroup> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

For the most part, <figgroup> is intended to be used as a base for specialization. This example uses it directly for purposes of illustration.

The following code sample shows how the <figgroup> can group content with associated metadata:

<fig>
  <title>Sample complex figure</title>
  <figgroup>
    <data name="MetaItem" value="13"/>
    <data name="MetaThing" value="31"/>
    <ph>These elements are grouped with associated metadata</ph>
  </figgroup>
</fig>

<fn>

A footnote is ancillary information that typically is rendered in the footer of a page or at the end of an online article. Such content is usually inappropriate for inline inclusion.

Usage information

There are two types of footnotes: single-use footnote and use-by-reference footnote.

Single-use footnote
This is produced by a <fn> element that does not specify a value for the @id attribute.
Use-by-reference footnote
This is produced by a <fn> element that specifies a value for the @id attribute. It must be used in conjunction with an <xref> element with @type set to fn.

To reference a footnote that is located in another topic, the conref or conkeyref mechanism is used.

Rendering expectations

The two footnote types typically produce different types of output:

Single-use footnote
When rendered, a superscript symbol (numeral or character) is produced at the location of the <fn> element. The superscript symbol is hyperlinked to the content of the footnote, which is placed at the bottom of a PDF page or the end of an online article. The superscript symbol can be specified by the value of the @callout attribute. When no @callout value is specified, footnotes are typically numbered.
Use-by-reference footnote
Nothing is rendered at the location of the <fn> element. The content of a use-by-reference footnote is only rendered when it is referenced by an <xref> with the @type attribute set to fn. If an <xref> with the @type attribute set to fn is present, a superscript symbol is rendered at the location of the <xref> element. Unless conref or conkeyref is used, the <fn> and <xref> must be located in the same topic.

However, the details of footnote processing and formatting are implementation dependent. For example, a tool that renders DITA as PDF might lack support for the @callout attribute, or footnotes might be collected as end notes for certain types of publications.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <sl> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <bodydiv> , <dd> , <div> , <entry> , <example> , <fig> , <figgroup> , <li> , <lines> , <lq> , <note> , <p> , <ph> , <pre> , <section> , <sli> , <stentry>

Zero or more of the following

Contained by

Inheritance

- topic/fn

The <fn> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attribute defined below.

@callout
Specifies the character or character string that is used for the footnote link.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <fn> element can be used.

Example 10. An example of a single-use footnote

The following code sample shows a single-use footnote. It contains a simple <fn> element, with no @id or @callout attribute.

<p>The memory storage capacity of the computer is 2 GB
<fn>A GB (gigabyte) is equal to 1000 million bytes</fn> 
with error correcting support.</p>

When rendered, typically a superscript symbol is placed at the location of the <fn> element; this superscript symbol is hyperlinked to the content of the <fn>, which is typically placed at the bottom of a PDF page or the end of an online article. The type of symbol used is implementation specific.

The above code sample might produce the following output similar to the following:


The screen capture shows a text in a document that includes a footnote. In the body of the text, the location of the footnote is marked with the numeral one in superscript. At the bottom on the page, the text of the footnote appears along with the associated numeral one. The edges of the screen capture are tattered, to indicate that the image is part of a larger document.
Example 11. An example of a single-use footnote with a @callout attribute

The following code sample shows a single-use footnote that uses a @callout attribute:

<p>The memory storage capacity of the computer is 2 GB
<fn callout="#">A GB (gigabyte) is equal to 1000 million bytes</fn>
with error correcting support.</p>

The rendered output is similar to that of the previous example, although processors that support it will render the footnote symbol as # (hashtag).

Example 12. A use-by-reference footnote

The following code sample shows use-by-reference footnotes. The <fn> elements have @id attributes, and inline <xref> elements reference those <fn> elements:

<section>
  <fn id="dog-name">Fido</fn>
  <fn id="cat-name">Puss</fn>
  <fn id="llama-name">My llama</fn>
  <!-- ... -->
  <p>I like pets. At my house, I have 
     a dog<xref href="#topic/dog-name" type="fn"/>,
     a cat<xref href="#topic/cat-name" type="fn"/>, and
     a llama<xref href="#topic/llama-name" type="fn"/>.
  </p>
</section>

The code sample might produce output similar to the following:



Example 13. A single-use footnote that uses conref

The following code sample shows footnotes stored in a shared topic (footnotes.dita):

<!-- Content from footnotes.dita -->
<topic id="footnotes">
  <title>Shared topic...</title>
  <body>
    <bodydiv>
      <fn id="strunk">Elements of Style</fn>
      <fn id="DQTI">Developing Quality Technical Information, 2nd edition</fn>
      <!-- ... -->
    </bodydiv>
  </body>
</topic>

To use those footnotes, authors conref them into the relevant topics:

<p>See the online resource<fn conref="footnotes.dita#footnotes/DQTI"/> for more 
   information about how to assess the quality of technical documentation ...</p>
Example 14. A use-by-reference footnote that uses conref

The following code sample shows a use-by-reference footnote that uses conref:

<topic id="evaluating-quality">
  <title>Evaluating documentation quality</title>
  <body>
    <bodydiv>
      <fn conref="footnotes.dita#footnotes/DQTI" id="dqti"/>
    </bodydiv>
    <!-- ... -->
    <p>See the online resource<xref="#./dqti" type="fn"/> for more 
       information about how to assess the quality of technical documentation./p>
    <!-- ... -->
  </body>
<topic>

<image>

An image is a reference to artwork that is stored outside of the content.

Rendering expectations

The referenced image typically is rendered in the main flow of the content.

Processors SHOULD scale the object when values are provided for the @height and @width attributes. The following expectations apply:
  • If a height value is specified and no width value is specified, processors SHOULD scale the width by the same factor as the height.
  • If a width value is specified and no height value is specified, processors SHOULD scale the height by the same factor as the width.
  • If both a height value and width value are specified, implementations MAY ignore one of the two values when they are unable to scale to each direction using different factors.
Content model

<alt> ?, <longdescref> ?

Contained by

<abstract> , <body> , <bodydiv> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <imagemap> , <li> , <linkinfo> , <lq> , <note> , <p> , <ph> , <section> , <shortdesc> , <sli> , <stentry> , <title> , <xref>

In order
  1. Optional <alt>
  2. Optional <longdescref>

Contained by

Inheritance

- topic/image

The <image> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @format, @href, @keyref, @scope, and the attributes defined below.

@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how an image is referenced. The @placement attribute is set to "break"; this ensures that the image is not rendered inline.

<image href="bike.gif" placement="break">
  <alt>Two-wheeled bicycle</alt>
</image>

<include>

Included content is a reference to non-DITA content outside the current document that will be rendered at the location of the reference. The resource is specified using either a URI or a key reference. Processing expectations for the referenced data can also be specified.

Usage information

The <include> element is intended as a base for specialization and for the following use cases:

  • The transclusion of non-DITA XML within <foreign> element using parse="xml"
  • The transclusion of preformatted textual content within <pre> element using parse="text"
  • The transclusion of plain-text prose within DITA elements using parse="text"

In addition, processors can support additional values for the @parse attribute.

For example, the <include> element can be specialized to an element such as <coderef> as a way to include preformatted sample programming code.

The <include> element is not intended to reference DITA content. Use @conref or @conkeyref to reuse DITA content.

Processing expectations

The <include> element instructs processors to insert the contents of the referenced resource at the location of the <include> element. If the content is unavailable to the processor or cannot be processed using the specified @parse value, the contents of the <fallback> element, if any, are presented instead.

Processors SHOULD support the @parse values text and xml.

Processors SHOULD detect the encoding of the referenced document based on the rules described for the @encoding attribute.

Content model

( <data> | <sort-as> )**, <fallback> ?, <foreign> *

Contained by

<abstract> , <b> , <bodydiv> , <data> , <dd> , <desc> , <div> , <draft-comment> , <dt> , <em> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <howtoavoid> , <i> , <li> , <line-through> , <lines> , <linkinfo> , <lq> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <section> , <sli> , <stentry> , <strong> , <sub> , <sup> , <tt> , <u>

In order
  1. Zero or more Zero or more of the following
  2. Optional <fallback>
  3. Zero or more <foreign>

Contained by

Inheritance

- topic/include

The <include> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: inclusion attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@encoding (inclusion attributes)
Specifies the character encoding to use when translating the character data from the referenced content. The value should be a valid encoding name. If not specified, processors may make attempts to automatically determine the correct encoding, for example using HTTP headers, through analysis of the binary structure of the referenced data, or the <?xml?> processing instruction when including XML as text. The resource should be treated as UTF-8 if no other encoding information can be determined.

When parse="xml", standard XML parsing rules apply for the detection of character encoding. The necessity and uses of @encoding for non-standard values of @parse are implementation-dependent.

@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@parse (inclusion attributes)
Specifies the processing expectations for the referenced resource. Processors must support the following values:
text

The contents should be treated as plain text. Reserved XML characters should be displayed, and not interpreted as XML markup.

xml

The contents of the referenced resource should be treated as an XML document, and the referenced element should be inserted at the location of the <include> element. If a fragment identifier is included in the address of the content, processors must select the element with the specified ID. If no fragment identifier is included, the root element of the referenced XML document is selected. Any grammar processing should be performed during resolution, such that default attribute values are explicitly populated. Prolog content must be discarded.

It is an error to use parse="xml" anywhere other than within <foreign> or a specialization thereof.

Processors may support other values for the @parse attribute with proprietary processing semantics. Processors should issue warnings and use <fallback> when they encounter unsupported @parse values. Non-standard @parse instructions should be expressed as URIs.

Note (non-normative):
Proprietary @parse values will likely limit the portability and interoperability of DITA content, so should be used with care.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

For the most part, <include> is intended to be used as a base for specialization. The following examples use it directly for purposes of illustration.

Example 15. Inclusion of XML markup other than SVG or MathML

In the following code sample, the <include> element references a tag library descriptor file:

<fig>
  <title>JSP tag library elements and attributes</title>
  <foreign outputclass="tld">
    <include href="../src/main/webapp/WEB-INF/jsp-tag-library.tld"
             parse="xml" format="tld"/>
  </foreign>
</fig>
Example 16. Inclusion of README text into a DITA topic, with fallback

In the following code sample, a README text file is referenced in order to reuse a list of changes to a set of source code:

<topic id="readme">
  <title>Summary of changes</title>
  <shortdesc>This topic describes changes in the project source code.</shortdesc>
  <body>
    <section>
      <include href="../src/README.txt" parse="text" encoding="UTF-8">
        <fallback>See README.txt in the source package for a list of changes.</fallback>
      </include>
    </section>
  </body>
</topic>
Example 17. Inclusion of preformatted text

In the following code sample, the <include> element references a JSON file:

<pre>
  <include href="../src/config.json" format="json" parse="text" encoding="UTF-8"/>
</pre>
Example 18. Proprietary vendor handling for CSV tables

In the following code sample, the <include> element specifies a proprietary @parse value that instructs a processor how to render a comma-separated data set within the figure:

<fig>
  <title>Data Table</title>
  <include href="data.csv" encoding="UTF-8"
    parse="http://www.example.com/dita/includeParsers/csv-to-simpletable"/>
</fig>

<keyword>

A keyword is text or a token that has a unique value, such as a product name or unit of reusable text.

Processing expectations

When used within the <keywords> element, the content of a <keyword> element is considered to be metadata and should be processed as appropriate for the given output medium.

Elements that are specialized from the <keyword> element might have extended processing, such as specific formatting or automatic indexing.

Content model

(Text | <draft-comment> | <required-cleanup> | <text> | <tm> )*

Contained by

<abstract> , <alt> , <author> , <b> , <bodydiv> , <brand> , <category> , <cite> , <component> , <consequence> , <coords> , <copyrholder> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <featnum> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <keywords> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <platform> , <pre> , <prodname> , <prognum> , <publisher> , <q> , <searchtitle> , <section> , <series> , <shortdesc> , <sli> , <sort-as> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/keyword

The <keyword> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <keyword> element can be used.

Example 19. <keyword> element used to store a product name

In the following code sample, the <keyword> element holds a product name that can be referenced using content reference (conref) or content key reference (conkeyref):

<keyword id="acme-bird-feeder">ACME Bird Feeder</keyword>

To enable referencing variable text using @keyref, store the product name in a <keytext> element.

Example 20. <keyword> element referencing a product name

In the following example, the <keyword> element references a product name using @conkeyref:

<p>To fill the <keyword conkeyref="productnames/acme-bird-feeder"/>, unscrew the top ...</p>
Example 21. <keyword> element as metadata

In the following code sample, "Big data" is specified as metadata that applies to the topic:

<prolog>
  <metadata>
    <keywords>
      <keyword>Big data</keyword>
    </keywords>
  </metadata>
</prolog>

<li>

A list item is an item in either an ordered or unordered list.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<ol> , <ul>

Zero or more of the following

Contained by

Inheritance

- topic/li

The <li> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <ol> or <ul>.

<lines>

Lines are lines of text where white space is significant. The <lines> element can be used to represent dialogs, poetry, or other text fragments where line breaks are significant.

Rendering expectations

Processors SHOULD preserve the line breaks and spaces that are present in the content of a <lines> element.

The contents of the <lines> element is typically rendered in a non-monospaced font.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <li> , <linkinfo> , <lq> , <note> , <p> , <section> , <stentry>

Zero or more of the following

Contained by

Inheritance

- topic/lines

The <lines> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: display attributes, universal attributes, and @xml:space.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@expanse (display attributes)
Specifies the horizontal placement of the element. The following values are valid:
column
Indicates that the element is aligned with the current column margin.
page
Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
spread
Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
textline
Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

For <table>, in place of the @expanse attribute that is used by other DITA elements, the @pgwide attribute is used in order to conform to the OASIS Exchange Table Model.

Some processors or output formats might not support all values.

@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@frame (display attributes)
Specifies which portion of a border surrounds the element. The following values are valid:
all
Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
bottom
Indicates that a line is rendered at the bottom of the containing element.
none
Indicates that no lines are rendered.
sides
Indicates that a line is rendered at the left and right of the containing element.
top
Indicates that a line is rendered at the top of the containing element.
topbot
Indicates that a line is rendered at the top and bottom of the containing element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

Some processors or output formats might not support all values.

@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

Specifies the percentage by which fonts are resized in relation to the normal text size. The value of this attribute is a positive integer. When used on <table> or <simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.

This attribute is primarily useful for print-oriented display. Some processors might not support all values.

If the @scale attribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the <image> element.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@xml:space
Specifies how to handle white space in the current element. This attribute is provided on <pre>, <lines>, and on elements specialized from those. It ensures that parsers respect white space that is part of the data in those elements, including line-end characters. When defined, it has a fixed value of preserve, making it a default property of the element that cannot be changed or deleted by authors.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In the following code sample, a <lines> element contains the text of [Buffalo Bill 's], a poem by e. e. cummings:

<lines>Buffalo Bill ’s
defunct
               who used to
               ride a watersmooth-silver
                                                                  stallion
and break onetwothreefourfive pigeonsjustlikethat
                                                                                         Jesus

he was a handsome man 
                                                  and what i want to know is
how do you like your blue-eyed boy
Mister Death</lines>

<longdescref>

A long description reference is a reference to a textual description of a graphic or object. This is typically used to provide an extended description when the graphic or object is too complicated to describe with alternate text.

Content model

EMPTY

Contained by

<audio> , <hazardsymbol> , <image> , <object> , <video>

Empty

Contained by

Inheritance

- topic/longdescref

The <longdescref> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <longdescref> element can be used.

Example 22. <longdescref> which references a local DITA description

In the following code sample, the <longdescref> references a detailed image description that is stored in a DITA topic:

<image href="llama.jpg">
  <alt>Llama picture</alt>
  <longdescref href="my-pet-llama.dita"/>
</image>
Example 23. <longdescref> which references an external description

In this code sample, the long description is stored remotely, on a external Web site:

<image href="puffin.jpg">
  <alt>Puffin pigure</alt>
  <longdescref href="http://www.example.org/birds/puffin.html"
               scope="external"
               format="html"/>
</image>

<lq>

A long quotation is a quotation that contains one or more paragraphs. The title and source of the document that is being quoted can be specified.

Rendering expectations

The contents of the <lq> element is typically rendered as an indented block.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <li> , <linkinfo> , <note> , <p> , <section> , <stentry>

Zero or more of the following

Contained by

Inheritance

- topic/lq

The <lq> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample contains a quotation. The <cite> attribute specifies the title of the document that is quoted.

<p>This is the first line of the address that Abraham Lincoln delivered
on November 19, 1863 for the dedication of the cemetery at Gettysburg, Pennsylvania.</p>
<lq>Four score and seven years ago our fathers brought forth on this continent 
a new nation, conceived in liberty, and dedicated to the proposition that all men
are created equal. <cite>Gettysburg address</cite>
</lq>

<note>

A note is information that expands on or calls attention to a particular point.

Usage information

The nature of a note (for example, caution, danger, or warning) is indicated through the values selected for the @type attribute.

The values danger, notice, and warning have meanings that are based on ANSI Z535 and ISO 3864 regulations.

If @type is set to other, the value of the @othertype attribute can be used as a label for the note. Many processors will require additional information on how to process the value.

Rendering expectations

Processors SHOULD render a label for notes. The content of the label depends on the values of the @type attribute.

A note is typically rendered in a way that stands out from the surrounding content.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <li> , <linkinfo> , <lq> , <p> , <section> , <stentry>

Zero or more of the following

Contained by

Inheritance

- topic/note

The <note> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a <note> with @type set to "tip":

<note type="tip">Thinking of a seashore, green meadow, or cool
mountain overlook can help you to relax and be more
patient.</note>

<object>

The DITA <object> element corresponds to the HTML <object> element, and the attribute semantics derive from the HTML definitions. Because of this, the @type attribute on <object> differs from the @type attribute on many other DITA elements.

Usage information

The <object> element enables authors to include animated images, applets, plug-ins, video clips, and other multimedia objects in a topic.

Rendering expectations
Processors SHOULD scale the object when values are provided for the @height and @width attributes. The following expectations apply:
  • If a height value is specified and no width value is specified, processors SHOULD scale the width by the same factor as the height.
  • If a width value is specified and no height value is specified, processors SHOULD scale the height by the same factor as the width.
  • If both a height value and width value are specified, implementations MAY ignore one of the two values when they are unable to scale to each direction using different factors.

When an object cannot be rendered in a meaningful way, processors SHOULD present the contents of the <fallback> element, if it is present.

Content model

<desc> ?, <longdescref> ?, <fallback> ?, <param> *, <foreign> *

Contained by

<abstract> , <body> , <bodydiv> , <data> , <dd> , <div> , <draft-comment> , <entry> , <example> , <fig> , <figgroup> , <fn> , <li> , <lq> , <note> , <p> , <section> , <stentry>

In order
  1. Optional <desc>
  2. Optional <longdescref>
  3. Optional <fallback>
  4. Zero or more <param>
  5. Zero or more <foreign>

Contained by

Inheritance

- topic/object

The <object> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@name
Defines a unique name for the object.
@tabindex
Specifies the position of the object in tabbing order.
@type
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

This section contains examples of how the <object> element can be used.

Example 24. Referencing a web page for display in an HTML inline frame (iframe)

The following code sample shows how an <object> element can be used to render a web page in an inline frame. It assumes that the processing engine uses the outputclass="iframe" directive.

<object type="text/html"
        data="https://www.openstreetmap.org/export/embed.html?bbox=-0.004017949104309083%2C51.47612752641776
              %2C0.00030577182769775396
              %2C51.478569861898606
              &layer=mapnik"
        width="800"
        height="600"
        id="map-uk-greenwich"
        outputclass="iframe">
   <desc>Greenwich, England</desc>
   <fallback><xref format="html" scope="external"
       href="https://www.openstreetmap.org/export/embed.html?bbox=-0.004017949104309083%2C51.47612752641776
              %2C0.00030577182769775396
              %2C51.478569861898606
              &layer=mapnik"
    /></fallback>
</object>

The above code might generate the following HTML:

<!DOCTYPE html>
<html>
  <head>
    <title>Test of Iframe</title>
  </head>
  <body>
    <p>Iframe:</p>
    <iframe src="https://www.openstreetmap.org/export/embed.html?bbox=-0.004017949104309083%2C51.47612752641776
      %2C0.00030577182769775396
      %2C51.478569861898606
      &layer=mapnik"       
      >Street map</iframe>
  </body>
</html>

Example 25. Object with reference to video using key reference on the <param> elements

The following code sample shows how key definitions can be used to reference supporting resources for an <object>:

<object id="E5123_026.mp4" width="300" height="300">
  <fallback>Media not available.</fallback>
  <param name="poster" keyref="E5123_026_poster" />
  <param name="source" keyref="E5123_026_video" />
</object>
In this scenario, the keys could be defined as follows:
<map>
  <!-- ... -->
  <keydef keys="E5123_026_poster"
      href="../images/E5123_026_poster.png"
      type="video/mp4"/>
  <keydef keys="E5123_026_video"
      href="../media/E5123_026_poster.mp4"
      type="video/mp4"/>
  <!-- ... -->
</map>
Example 26. Object with indirect reference to a flash file

The following code sample shows how key definitions can be used to reference the main content for an <object>:

<object id="cutkey370"
    datakeyref="cutkey370"
    height="280"
    width="370">
  <desc>Video illustration of how to cut a key</desc>
  <fallback>Media not available.</fallback>
  <param name="movie" keyref="cutkey370"/>
  <param name="quality" value="high"/>
  <param name="bgcolor" value="#FFFFFF"/>
</object>
In this scenario, the keys could be defined as follows:
<map>
  <!-- ... -->

  <!-- Using @scope="external" here because the referenced URL is external. -->
  <keydef keys="cutkey370"
    href="https://www.example.com/cutkey370.swf"
    type="application/x-shockwave-flash"
    format="swf"
    scope="external" />

  <!-- ... -->
</map>

<ol>

An ordered list is a list of items that are sorted by sequence or order of importance.

Rendering expectation

List items are typically indicated by numbers or alphabetical characters.

Content model

( <data> | <sort-as> )*, <li> +

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <howtoavoid> , <li> , <linkinfo> , <lq> , <note> , <p> , <section> , <stentry>

In order
  1. Zero or more of the following
  2. One or more <li>

Contained by

Inheritance

- topic/ol

The <ol> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @compact.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@compact
Specifies whether the vertical spacing between list items is tightened. The following values are valid: yes, no, and -dita-use-conref-target. Some DITA processors or output formats might not support the @compact attribute.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows the use of an ordered list:

<p>Here is a list of the five longest-living people who were born in the 19th century:</p>
<ol>
  <li>Jeanne Calment (1875-1997)</li>
  <li>Sarah Knauss (1880-1999)</li>
  <li>Marie-Louise Meilleur (1880-1998)</li>
  <li>Emma Morano (1899-2017)</li>
  <li>Misao Okawa (1898-2015)</li>
</ol>
<p>Note that systematic verification has only been practised in recent years and only
 in certain parts of the world.</p>

<p>

A paragraph is a group of related sentences that support a central idea.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <li> , <linkinfo> , <lq> , <note> , <section> , <stentry>

Zero or more of the following

Contained by

Inheritance

- topic/p

The <p> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample contains a paragraph:

<p>A paragraph is a group of related sentences that support a central 
idea. Paragraphs typically consist of three parts: a topic sentence, body sentences, 
and a concluding or bridging sentence.</p>

<param>

The <param> (parameter) element specifies a set of values that might be required by an <object> at runtime.

Usage information

Any number of <param> elements might appear in the content of an <object> in any order, but must be placed at the start of the content of the enclosing object. This element is comparable to the HMTL <param> element, and the attribute semantics derive from their HTML definitions. For example, the @type attribute differs from the @type attribute on many other DITA elements.

Processing expectations
The @keyref attribute on <param> has the following expectations:
  1. When the key specified by @keyref is resolvable and has an associated URI, that URI is used as the value of this element (overriding @value, if that is specified).
  2. When the key specified by @keyref is resolvable and has no associated resource (only link text), the @keyref attribute is considered to be unresolvable for this element. If @value is specified, it is used as a fallback.
  3. When the key specified by @keyref is not resolvable, the value of the @value attribute is used as a fallback target for the <param> element.
Content model

EMPTY

Contained by

<object>

Empty

Contained by

Inheritance

- topic/param

The <param> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@keyref
Specifies a key reference to the thing the parameter references.
@name (REQUIRED)
Specifies the name of the parameter.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <object>.

<ph>

A phrase is a small group of words that stand together as a unit, typically forming a component of a clause.

Usage information

The <ph> element often is used to enclose a phrase for reuse or conditional processing.

The <ph> element frequently is used as a specialization base, to create phrase-level markup that can provide additional semantic meaning or trigger specific processing or formatting. For example, all highlighting domain elements are specializations of <ph>.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <image> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<abstract> , <alt> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/ph

The <ph> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows <ph> elements that are used for conditional processing:

<p>The Style menu is the <ph product="Software1000"/>third item</ph>
<ph product="Software9000"/>fourth item</ph> from the left on the menu bar.</p>

<pre>

Preformatted text is text that contains line breaks and spaces that are intended to be preserved at publication time.

Usage information

The <pre> element is often used for ASCII diagrams and code samples. It is the specialization base for the @codeblock element in the Technical Content edition.

Rendering expectations

Processors SHOULD preserve the line breaks and spaces that are present in the content of a <pre> element.

The contents of the <codeblock> element is typically rendered in a monospaced font.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <li> , <linkinfo> , <lq> , <note> , <p> , <section> , <stentry>

Zero or more of the following

Contained by

Inheritance

- topic/pre

The <pre> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: display attributes, universal attributes, and @xml:space.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@expanse (display attributes)
Specifies the horizontal placement of the element. The following values are valid:
column
Indicates that the element is aligned with the current column margin.
page
Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
spread
Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
textline
Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

For <table>, in place of the @expanse attribute that is used by other DITA elements, the @pgwide attribute is used in order to conform to the OASIS Exchange Table Model.

Some processors or output formats might not support all values.

@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@frame (display attributes)
Specifies which portion of a border surrounds the element. The following values are valid:
all
Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
bottom
Indicates that a line is rendered at the bottom of the containing element.
none
Indicates that no lines are rendered.
sides
Indicates that a line is rendered at the left and right of the containing element.
top
Indicates that a line is rendered at the top of the containing element.
topbot
Indicates that a line is rendered at the top and bottom of the containing element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

Some processors or output formats might not support all values.

@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

Specifies the percentage by which fonts are resized in relation to the normal text size. The value of this attribute is a positive integer. When used on <table> or <simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.

This attribute is primarily useful for print-oriented display. Some processors might not support all values.

If the @scale attribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the <image> element.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@xml:space
Specifies how to handle white space in the current element. This attribute is provided on <pre>, <lines>, and on elements specialized from those. It ensures that parsers respect white space that is part of the data in those elements, including line-end characters. When defined, it has a fixed value of preserve, making it a default property of the element that cannot be changed or deleted by authors.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows preformatted text that contains white space and line breaks. When the following code sample is published, the white space and line breaks are preserved.

<pre>
          MEMO: programming team fun day
Remember to bring a kite, softball glove, or other favorite
outdoor accessory to tomorrow's fun day outing at Zilker Park.
Volunteers needed for the dunking booth.
</pre>

<q>

A quotation is a small group of words that is taken from a text or speech and repeated by someone other than the original author or speaker.

Rendering expectations

Processors add appropriate styling, such as locale-specific quotation marks, around the contents of the <q> element and render it inline.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <b> , <bodydiv> , <cite> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <li> , <line-through> , <lines> , <linkinfo> , <lq> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <section> , <shortdesc> , <sli> , <stentry> , <strong> , <sub> , <sup> , <title> , <tt> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/q

The <q> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In the following code sample, the <q> element contains a quotation. Note that no quotation marks are included; locale-specific quotation marks will be generated during processing.

<p>
George said, <q>Disengage the power supply before servicing the unit.</q>
</p>

<section>

A section is an organizational division in a topic. Sections are used to organize subsets of information that are directly related to the topic.

Usage information

Multiple sections within a single topic do not represent a hierarchy, but rather peer divisions of that topic. Sections cannot be nested. Sections can have titles.

Note (non-normative):
For maximum flexibility in creating specializations, sections allow plain text as well as phrase and block level elements. Because of the way XML grammars are defined within a DTD, any element that allows plain text cannot restrict the order or frequency of other elements. As a result, the <section> element allows <title> to appear anywhere as a child of <section>. However, the intent of the specification is that <title> only be used once in any <section>, and when used, that it precede any other text or element content.
Rendering expectations

Processors SHOULD treat the presence of more than one <title> element in a <section> element as an error.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <title> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<body> , <bodydiv>

Zero or more of the following

Contained by

Inheritance

- topic/section

The <section> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how element-reference topics in the DITA specification use titled sections to provide a consistent structure for grouping information:

<reference id="p" xml:lang="en-us">
  <title><xmlelement>p</xmlelement></title>
  <shortdesc conkeyref="library-short-descriptions/p"/>
  <refbody>
    <section><title>Usage information</title>
      <p>...</p>
    </section>
    <section><title>Rendering expectations</title>
      <p>...</p>
    </section>
    <section><title>Processing expectations</title>
      <p>...</p>
    </section>
    <section><title>Specialization hierarchy</title>
      <p>...</p>
    </section>
    <section><title>Attributes</title>
      <p>...</p>
    </section>
    <example><title>Example</title>
      <p>...</p>
    </example>
  </refbody>
</reference>

<sl>

A simple list is a list that contains a few items of short, phrase-like content.

Rendering expectations

A simple list is typically rendered in the following way:

  • The content of each simple list item is placed on a separate line.
  • The lines are not distinguished by numbers, bullets, or icons.
Content model

( <data> | <sort-as> )*, <sli> +

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <howtoavoid> , <li> , <linkinfo> , <lq> , <note> , <p> , <section> , <stentry>

In order
  1. Zero or more of the following
  2. One or more <sli>

Contained by

Inheritance

- topic/sl

The <sl> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @compact.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@compact
Specifies whether the vertical spacing between list items is tightened. The following values are valid: yes, no, and -dita-use-conref-target. Some DITA processors or output formats might not support the @compact attribute.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how a simple list could be used in a topic that discusses related modules:

<section>
  <title>Messages</title>
  <p>Messages from the ags_open module are identical with messages from:</p>
  <sl>
    <sli>ags_read</sli>
    <sli>ags_write</sli>
    <sli>ags_close</sli>
  </sl>
</section>

<sli>

A simple list item is a component of a simple list. A simple list item contains a brief phrase or text content, adequate for describing package contents, for example.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <image> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<sl>

Zero or more of the following

Contained by

Inheritance

- topic/sli

The <sli> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <sl>.

<term>

A term is a word or phrase that has specific meanings in certain contexts. It might have or require extended definitions or explanations.

Usage information

The @keyref attribute can be used in conjunction with the <term> element to accomplish the following:

  • Supply the text content for the <term> element
  • Associate a term with a resource, typically a definition of the term
Content model

(Text | <draft-comment> | <required-cleanup> | <text> | <tm> )*

Contained by

<abstract> , <alt> , <author> , <b> , <bodydiv> , <brand> , <category> , <cite> , <component> , <consequence> , <coords> , <copyrholder> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <featnum> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <platform> , <pre> , <prodname> , <prognum> , <publisher> , <q> , <searchtitle> , <section> , <series> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/term

The <term> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code samples shows how the <term> element can be used

Example 27. Simple use of the <term> element

In the following code sample, the <term> element is used simply to identify that reference implementation is a term:

<p>A <term>reference implementation</term> of DITA implements the standard, 
fallback behaviors intended for DITA elements.</p>
Example 28. The <term> element used to reference an external definition

In the following code sample, the <term> element is used to reference an external resource that defines the term:

<p>A <term keyref="reference-implementation">reference implementation</term> of DITA 
implements the standard, fallback behaviors intended for DITA elements.</p>

When combined with the following key definition, processors might render the phrase reference implementation as a hyperlink to the associated Wikipedia page:

<map>
  <title>Information about DITA</title>
  <keydef keys="reference-implementation"
          href="https://en.wikipedia.org/wiki/Reference_implementation"
          format="html" scope="external"/>
  <!-- ... -->
</map>

<text>

The <text> element is a container for text. It does not have any associated semantics.

Usage information

The <text> element is primarily used as a base for specialization or to enable reuse. The <text> element can contain only text or nested <text> elements.

Content model

(Text | <text> )*

Contained by

<abstract> , <alt> , <author> , <b> , <bodydiv> , <brand> , <category> , <cite> , <component> , <consequence> , <coords> , <copyrholder> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <featnum> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <keyword> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <platform> , <pre> , <prodname> , <prognum> , <publisher> , <q> , <searchtitle> , <section> , <series> , <shape> , <shortdesc> , <sli> , <sort-as> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <term> , <text> , <title> , <titlealt> , <titlehint> , <tm> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/text

The <text> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In the following code sample, the <text> element is used to contain text that is intended to be reused:

<p>This an example of <text id="reuse">Text that is reusable</text>, 
            with no extra semantics attached to the text.</p>

<tm>

A trademark is a term or phrase that is trademarked. Trademarks include registered trademarks, service marks, slogans, and logos.

Usage information

The business rules for indicating and displaying trademarks differ from company to company. These business rules can be enforced by either authoring policy or processing.

Content model

(Text | <text> | <tm> )*

Contained by

<abstract> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <keyword> , <li> , <line-through> , <lines> , <linkinfo> , <lq> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <section> , <shortdesc> , <sli> , <stentry> , <strong> , <sub> , <sup> , <term> , <title> , <tm> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/tm

The <tm> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@trademark
Specifies the trademarked term.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how a company might use the <tm> element:

<p>The advantages of using the 
  <tm trademark="Acme" tmtype="reg">Acme</tm> 
  <tm trademark="SuperFancyWidget" tmtype="tm">SuperFancyWidget</tm>
  are well known to Bugs Bunny fans.</p>

<ul>

An unordered list is a list in which the order of items is not significant.

Rendering expectation

List items are typically indicated by bullets or dashes.

Content model

( <data> | <sort-as> )*, <li> +

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <howtoavoid> , <li> , <linkinfo> , <lq> , <note> , <p> , <section> , <stentry>

In order
  1. Zero or more of the following
  2. One or more <li>

Contained by

Inheritance

- topic/ul

The <ul> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @compact.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@compact
Specifies whether the vertical spacing between list items is tightened. The following values are valid: yes, no, and -dita-use-conref-target. Some DITA processors or output formats might not support the @compact attribute.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a list in which the order of items is unimportant:

<p>Here are the countries that I have visited:</p>
<ul>
  <li>Germany</li>
  <li>France</li>
  <li>Japan</li>
  <li>Mexico</li>
</ul>

<xref>

A cross reference is an inline link. A cross reference can link to a different location within the current topic, another topic, a specific location in another topic, or an external resource such as a PDF or web page.

Content model

(Text | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <cite> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> | <image> | <desc> )*

Contained by

<abstract> , <area> , <b> , <bodydiv> , <data> , <dd> , <desc> , <div> , <draft-comment> , <dt> , <em> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <howtoavoid> , <i> , <li> , <line-through> , <lines> , <linkinfo> , <lq> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <section> , <shortdesc> , <sli> , <stentry> , <strong> , <sub> , <sup> , <tt> , <u>

Zero or more of the following

Contained by

Inheritance

- topic/xref

The <xref> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <xref> element can be used.

Example 29. Cross reference to another topic, without link text

The following code sample shows a cross reference to another topic. Link text is not provided. Processor typically use the topic title as the link text.

<p>Background information about DITA is provided in
<xref href="overview-of-dita.dita"/>.</p>

The same cross reference could be created using @keyref instead of @href. Using @keyref allows the link to be redirected to different resources when the topic is used in different contexts.

Example 30. Cross references with link text specified

The following code sample shows a cross reference that specifies link text:

<p>While this set of tutorials gives several simple examples of
<xref keyref="markup-examples">common DITA features</xref>, a comprehensive
list of DITA features is available in the DITA specification
<xref keyref="dita-conformance">conformance clause</xref>.</p>
Example 31. Cross reference to an external ressource

The following code sample shows a cross reference to a web page:

<xref href="https://www.example.com/docview.wss?rs=757"
scope="external" format="html">Part number SSVNX5/>

Multimedia elements

The multimedia elements are used to reference audio or video content. The elements in this domain are modeled on the HTML5 <audio> and <video> elements.

<audio>

Audio is sound that the human ear is capable of hearing.

Usage information

The <audio> element is modeled on the HTML5 <audio> element.

An audio resource can be referenced by @href, @keyref, and nested <media-source> elements.

Playback behaviors such as auto-playing, looping, and muting are determined by attributes. When not specified, the default behavior is determined by the user agent that is used to present the media.

Rendering expectations

When an audio resource cannot be rendered in a meaningful way, processors SHOULD present the contents of the <fallback> element, if it is present.

Content model

<desc> ?, <longdescref> ?, <fallback> ?, <media-source> *, <media-track> *, <foreign> *

Contained by

<abstract> , <body> , <bodydiv> , <data> , <dd> , <div> , <draft-comment> , <entry> , <example> , <fig> , <figgroup> , <fn> , <li> , <lq> , <note> , <p> , <section> , <stentry>

In order
  1. Optional <desc>
  2. Optional <longdescref>
  3. Optional <fallback>
  4. Zero or more <media-source>
  5. Zero or more <media-track>
  6. Zero or more <foreign>

Contained by

Inheritance

- topic/audio

The <audio> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @format, @href, @keyref, @scope, and the attributes defined below.

For this element, the following considerations apply:
  • The @format attribute specifies the MIME type for the resource. This attribute enables processors to avoid loading unsupported resources. If @format is not specified and @keyref is specified, the effective type for the key named by the @keyref attribute is used as the value. If an explicit @format is not specified on either the <audio> element or key definition, processors can use other means, such as the URI file extension, to determine the effective MIME type of the resource.
  • The @href attribute specifies the absolute or relative URI of the audio resource. If @href is specified, also specify @format.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@tabindex
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
The @format attribute specifies the MIME type for the resource. This attribute enables processors to avoid loading unsupported resources. If @format is not specified and @keyref is specified, the effective type for the key named by the @keyref attribute is used as the value. If an explicit @format is not specified on either the <audio> element or key definition, processors can use other means, such as the URI file extension, to determine the effective MIME type of the resource.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
The @href attribute specifies the absolute or relative URI of the audio resource. If @href is specified, also specify @format.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

Example 32. An <audio> element that uses direct addressing

In the following code sample, an audio resource is referenced using direct addressing. The @type attribute specifies the MIME type of the audio resource. 

<audio href="message.mp3" format="audio/mp3"/>
Example 33. An <audio> element that uses indirect addressing

In the following code sample, the audio resource is addressed using a key reference:

<audio keyref="message"/>

Both the URI and the MIME type are specified on the key definition:

<keydef keys="message" href="message.mp3" format="audio/mp3"/>
Example 34. An <audio> element with multiple formats

In the following code sample, <media-source> elements are used to specify the different audio formats that are available.

<audio>
  <media-source href="message.mp3" format="audio/mp3"/>
  <media-source href="message.wav" format="audio/wav"/>
</audio>
Example 35. Example of a complex <audio> element

The following code sample specifies an audio resource and defines multiple presentational details. It also provides fallback behavior for when the audio resource cannot be rendered.

<audio autoplay="true"
                controls="true"
                loop="false"
                muted="false">
  <desc>A sound file narrating the performance of this procedure.</desc>
  <fallback>The audio track walking through this procedure is not available.</fallback>
  <!-- Multiple formats, with URI and MIME type referenced using a key -->
  <media-source keyref="walkthrough-mp3"/>
  <media-source keyref="walkthrough-wav"/>
</audio>

<media-source>

The media source specifies the location of an audio or video resource.

Usage information

The media source is modeled on the <source> element used in HTML5 media elements.

Rendering expectations

When multiple <media-source> elements are present, the user agent evaluates them in document order and selects the first resource that can be played.

Content model

EMPTY

Contained by

<audio> , <video>

Empty

Contained by

Inheritance

- topic/media-source

The <media-source> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @format, @href, @keyref, and @scope.

For this element, the @href attribute specifies the URI of the track resource.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
For this element, the @href attribute specifies the URI of the track resource.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <audio> and <video>.

<media-track>

Media track settings specify the location of supplemental, text-based data for the referenced media, for example, subtitles or descriptions.

Usage information

The media track settings are modeled on the <track> element used in HTML5 media elements. They refer to track resources that use Web Video Text Track Format (WebVTT).

Content model

Text

Contained by

<audio> , <video>

Text

Contained by

Inheritance

- topic/media-track

The <media-track> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @format, @href, @keyref, @scope, and the attributes defined below.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.

For this element, the @href attribute specifies the URI of the track resource.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
For this element, the @href attribute specifies the URI of the track resource.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See Examples in the <video> topic.

<video>

A video is a recording of moving visual images.

Usage information

The <video> element is modeled on the HTML5 <video> element.

A video resource can be referenced by @href, @keyref, and nested <media-source> elements.

Playback behaviors such as auto-playing, looping, and muting are determined by attributes. When not specified, the default behavior is determined by the user agent that is used to present the media.

Rendering expectations

The video resource typically is rendered in the main flow of the content.

Processors SHOULD scale the video resource when values are provided for the @height and @width attributes. The following expectations apply:
  • If a height value is specified and no width value is specified, processors SHOULD scale the width by the same factor as the height.
  • If a width value is specified and no height value is specified, processors SHOULD scale the height by the same factor as the width.
  • If both a height value and width value are specified, implementations MAY ignore one of the two values when they are unable to scale to each direction using different factors.

When a video resource cannot be rendered in a meaningful way, processors SHOULD render the contents of the <fallback> element, if it is present.

Content model

<desc> ?, <longdescref> ?, <fallback> ?, <video-poster> ?, <media-source> *, <media-track> *, <foreign> *

Contained by

<abstract> , <body> , <bodydiv> , <data> , <dd> , <div> , <draft-comment> , <entry> , <example> , <fig> , <figgroup> , <fn> , <li> , <lq> , <note> , <p> , <section> , <stentry>

In order
  1. Optional <desc>
  2. Optional <longdescref>
  3. Optional <fallback>
  4. Optional <video-poster>
  5. Zero or more <media-source>
  6. Zero or more <media-track>
  7. Zero or more <foreign>

Contained by

Inheritance

- topic/video

The <video> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @format, @href, @keyref, @scope, and the attributes defined below.

@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@height
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@tabindex
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@width
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.

For this element, the following considerations apply:

  • The @format attribute specifies the MIME type for the resource. This attribute enables processors to avoid loading unsupported resources. If @format is not specified and @keyref is specified, the effective type for the key named by the @keyref attribute is used as the value. If an explicit @format is not specified on either the <video> element or key definition, processors can use other means, such the URI file extension, to determine the effective MIME type of the resource.
  • The @href attribute specifies the absolute or relative URI of the video resource. If @href is specified, also specify @format.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <video> element can be used.

Example 36. Example of a <video> element that uses direct addressing

In the following code sample, a video resource is referenced using direct addressing. The @format attribute specifies the MIME type of the video. 

<video href="video.mp4" format="video/mp4"/>
Example 37. Example of a <video> element that uses indirect addressing

In the following code sample, the video resource is addressed using a key reference:

<video keyref="video"/>

The URI and the MIME type do not need to be specified on the <video> element, since they are specified on the key definition:

<keydef keys="video" href="video.mp4" format="video/mp4"/>
Example 38. Example of a <video> element with multiple formats

In the following code sample, <media-source> elements are used to specify the different video formats that are available.

<video>
  <media-source href="video.mp4" format="video/mp4"/>
  <media-source href="video.ogg" format="video/ogg"/>
  <media-source href="video.webm" format="video/webm"/>
</video>
Example 39. Example of a <video> element with multiple formats and multilingual subtitles

The following code sample defines multiple presentational details for a video that is available in multiple formats. The video is referenced using key reference and a fallback image is provided for use when the video cannot be displayed.

<video height="300px"
                loop="false"
                muted="false"
                width="400px">
  <desc>A video illustrating this procedure.</desc>
  <fallback>
    <image href="video-not-available.png">
      <alt>This video cannot be displayed.</alt>
    </image>
  </fallback>
  <video-poster keyref="demo1-video-poster"/>
  <!-- Multiple formats, referenced via key. The key definition 
       specifies both the URI and the MIME type -->
  <media-source keyref="demo1-video-mp4"/>
  <media-source keyref="demo1-video-ogg"/>
  <media-source keyref="demo1-video-webm"/>
  <!-- Subtitle tracks in English, French and German.
       Each key definition provides a URI and sets type="subtitles". -->
  <media-track srclang="en" keyref="demo1-video-subtitles-en"/>
  <media-track srclang="fr" keyref="demo1-video-subtitles-fr"/>
  <media-track srclang="de" keyref="demo1-video-subtitles-de"/>
</video>

<video-poster>

A video poster is an image that is displayed while a video is loading.

Usage information

The <video-poster > element is modeled on the @poster attribute that can be specified on the HTML5 <video> element.

Content model

EMPTY

Contained by

<video>

Empty

Contained by

Inheritance

- topic/video-poster

The <video-poster> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @format, @href, @keyref, and @scope.

For this element, the @href attribute specifies the URI of the poster resource.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
For this element, the @href attribute specifies the URI of the poster resource.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <video>.

Indexing elements

The indexing elements provide content that a processor can use to generate indexes.

<index-see>

An <index-see> element directs the reader to an index entry that the reader should use instead of the current one.

Usage information

There can be multiple <index-see> elements within an <indexterm> element.

Processing expectations

Processors SHOULD ignore an <index-see> element if its parent <indexterm> element contains any <indexterm> children.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <indexterm> )*

Contained by

<indexterm>

Zero or more of the following

Contained by

Inheritance

- topic/index-see

The <index-see> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how <index-see> elements can be used.

Example 40. Use of an <index-see> element

The following code sample shows how an <index-see> element is used to refer readers to the preferred term:

<indexterm>Carassius auratus
  <index-see>goldfish</index-see>
</indexterm>

This markup will generate an index entry without a page reference. It might look like the following:


This screen capture shows a portion of a generated index. The reader is instructed to look in the index for the vernacular term goldfish, rather than the Latin Carassius auatus. The edges of the screen capture are tattered, to indicate that the image is part of a larger document.
Example 41. Use of an <index-see> element to redirect to a multi-level index entry

The following code sample shows how an <index-see> is used to redirect to a multilevel index entry:

<indexterm>feeding goldfish
  <index-see>goldfish
    <indexterm>feeding</indexterm>
  </index-see>
</indexterm>

<index-see-also>

An <index-see-also> element directs the reader to an index entry that the reader can use in addition to the current one.

Usage information

A single <indexterm> element can contain mulitple <index-see-also> elements.

Processing expectations

Processors SHOULD ignore an <index-see-also> element if its parent <indexterm> element contains any <indexterm> children.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <indexterm> )*

Contained by

<indexterm>

Zero or more of the following

Contained by

Inheritance

- topic/index-see-also

The <index-see-also> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how <index-see-also> elements can be used.

Example 42. Use of an <index-see-also> element

The following code sample shows the use of an <index-see-also> element to generate a "see also" reference to the index entry for "goldfish". 

<indexterm>carp
  <index-see-also>goldfish</index-see-also>
</indexterm>

This markup generates a primary index entry for "carp" and a redirection that instructs the reader to "see also goldfish".

Example 43. Use of an <index-see-also> element to redirect to a multilevel index entry

The following code sample shows the use of an <index-see-also> element to redirect to a multilevel <indexterm> element:

<indexterm>feeding
  <index-see-also>goldfish
    <indexterm>feeding</indexterm>
  </index-see-also>
</indexterm>

<indexterm>

An <indexterm> element contains content that is used to produce an index entry. Nested <indexterm> elements create multi-level indexes.

Rendering expectations

The content of @indexterm entries is not rendered in the flow of body text; it is rendered only as part of an index.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <indexterm> | <index-see> | <index-see-also> )*

Contained by

<abstract> , <bodydiv> , <dd> , <div> , <entry> , <example> , <index-see> , <index-see-also> , <indexterm> , <keywords> , <li> , <lines> , <lq> , <note> , <p> , <ph> , <pre> , <section> , <sli> , <stentry>

Zero or more of the following

Contained by

Inheritance

- topic/indexterm

The <indexterm> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @keyref, and the attributes defined below.

@start
Specifies an identifier that indicates the start of an index range.
@end
Specifies an identifier that indicates the end of an index range.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how <indexterm> elements can be used.

Example 44. Index reference to a point within in a topic

When index entries are placed in the body of a topic, they serve as point references to their location in the topic.

In the following code sample, the <indexterm> element provides a point reference to the beginning of the paragraph.

<p><indexterm>databases</indexterm>Databases are used to ...</p>
Example 45. Index entries within topic prologues or DITA maps

When index entries are located within the <prolog> element in a topic or the <topicmeta> element in a DITA map, they serve as point references to the start of the topic title.

In the following code sample, the <indexterm> element provides a reference to the topic as a whole; the generated index entry is associated with the start of the <title> element.

<topic id="about-databases">
  <title>About databases</title>
  <prolog>
    <metadata>
      <keywords>
        <indexterm>databases</indexterm>
      </keywords>
    </metadata>
  </prolog>
  <body>
    <!-- content... -->
  </body>
</topic>

The effect is the same as if the <indexterm> element had been located in the map:

<map>
  <topicref href="aboutdatabases.dita">
    <topicmeta>
      <keywords>
        <indexterm>databases</indexterm>
      </keywords>
    </topicmeta>
  </topicref>
  <!-- ... -->
</map>
Example 46. A simple index range

A simple index range will look something like this:

<indexterm start="cheese">cheese</indexterm>
<!-- ... additional content -->
<indexterm end="cheese"/>

This markup will generate a top-level index term for "cheese" that covers a series of pages, such as:

cheese 18-24

Example 47. A more complex index range

Specifying a range for nested terms is similar. In this sample, the range is specified for the tertiary index entry "pecorino":

<indexterm>cheese
  <indexterm>sheeps milk
    <indexterm start="level-3-pecorino">pecorino</indexterm>
  </indexterm>
</indexterm>
 <!-- ... additional content ... -->
<indexterm end="level-3-pecorino"/>

Related links elements

The related links elements define, group, and describe hyperlinks that are embedded in a DITA topic. The links are contained by the <related-links> element and apply to the DITA topic as a whole.

<linkinfo>

Link information is a description of the links that are contained in a <linklist> element. It can provide additional information about those links.

Rendering expectations

The <linkinfo> element is considered part of the content flow and typically rendered as a paragraph.

Content model

(Text | <dl> | <div> | <imagemap> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <ol> | <p> | <pre> | <sl> | <ul> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<linklist>

Zero or more of the following

Contained by

Inheritance

- topic/linkinfo

The <linkinfo> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <linklist>.

<linkpool>

A link pool is a group of links. The order that the links are rendered in the output is determined by the processor.

Rendering expectations

The order in which links in a <linkpool> element are rendered is processor-specific. A processor might sort links based on role or type. A processor might move or remove links based on the context. For example, prerequisite links might be rendered at the beginning of a Web page, or links to the next topic might be removed if the two topics are rendered on the same page in a PDF.

Processing expectations

Attributes that cascade between topic references in a map, such as the @scope and @format attributes, also cascade from this element to contained links.

Content model

( <linkpool> | <link> )*

Contained by

<linkpool> , <related-links>

Zero or more of the following

Contained by

Inheritance

- topic/linkpool

The <linkpool> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @collection-type, @duplicates, @format, @otherrole, @role, @scope, and @type.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@duplicates
Specifies whether duplicate links are removed from a group of links. Duplicate links are links that address the same resource using the same properties, such as link text and link role. How duplicate links are determined is processor-specific. The following values are valid:
yes
Specifies that duplicate links are retained.
no
Specifies that duplicate links are removed.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

The suggested processing default is yes within <linklist> elements and no for other links.

@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@otherrole
Specifies an alternate role for a link relationship when the @role attribute is set to other.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@role
Specifies the role that a linked topic plays in relationship with the current topic.

For example, in a parent/child relationship, the role would be parent when the target is the parent of the current topic, and child when the target is the child of the current topic. This can be used to sort and classify links when rendering.

The following values are valid:

ancestor
Indicates a link to a topic above the parent topic.
child
Indicates a link to a direct child such as a directly nested or dependent topic.
cousin
Indicates a link to another topic in the same hierarchy that is not a parent, child, sibling, next, or previous.
descendant
Indicates a link to a topic below a child topic.
friend
Indicates a link to a similar topic that is not necessarily part of the same hierarchy.
next
Indicates a link to the next topic in a sequence.
other
Indicates any other kind of relationship or role. The type of role is specified as the value for the @otherrole attribute.
parent
Indicates a link to a topic that is a parent of the current topic.
previous
Indicates a link to the previous topic in a sequence.
sibling
Indicates a link between two children of the same parent topic.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how a <linkpool> element is used to group a set of conceptual information. The order in which the links are rendered in the output is processor-dependent. In this example, the @type attribute on the <linkpool> element cascades to nested <link> elements.

<related-links>
  <linkpool type="concept">
    <link href="czez.dita#czez" role="next"/>
    <link href="czunder.dita"/>
    <link format="html" href="czover.htm#sqljsupp" role="parent">
      <linktext>Overview of the CZ</linktext>
    </link>
    <link format="html" href="czesqlj.htm#sqljemb">
      <linktext>Working with CZESQLJ</linktext>
      <desc>When you work with CZESQLJ, you need to know...</desc>
    </link>
  </linkpool>
</related-links>

<linktext>

Link text is the label for a link or resource.

Usage information

The <linktext> element provides descriptive text for a link. It is most commonly used when the target cannot be resolved during processing or when a title for the reference cannot be determined by a processor. For example, link text might be required when the link is to a peer, external, or non-DITA resource.

Rendering expectations

When a link contains a <linktext> element, the content of the <linktext> element is rendered instead of the text that retrieved from the resource.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> )*

Contained by

<link>

Zero or more of the following

Contained by

Inheritance

- topic/linktext

The <linktext> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how a <linktext> element can be used to provide link text for a related link to a non-DITA resource:

<related-links>
  <link href="SQLJ-example.html" format="html" scope="local">
    <linktext>Accessing relational data with SQLJ</linktext>
  </link>
</related-links>

Table elements

DITA topics support two types of tables: complex table and simple table.

The <table> element uses the OASIS Exchange Table Model, a simplification of the CALS table model. The complex table provides a wide variety of controls over the display properties of the data and even the table structure itself.

The <simpletable> element is structurally less complex than the <table> element and so is an easier base for specialization. It reflects a content model that is close to the HTML table. The <simpletable> element does not provide much control over formatting, although it permits titles and row and column spanning.

<colspec>

A column specification provides information about a single column in a table that is based on the OASIS Exchange Table Model. The information might include a column name and number, cell content alignment, or column width.

Content model

EMPTY

Contained by

<tgroup>

Empty

Contained by

Inheritance

- topic/colspec

The <colspec> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: localization attributes, ID and conref attributes, @align, @base, @char, @charoff, @class, @colsep, @outputclass, @rowheader, @rowsep, and the attributes defined below.

@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of text in table entries. The following values are valid:
left
Indicates left alignment of the text.
right
Indicates right alignment of the text.
center
Indicates center alignment of the text.
justify
Justifies the contents to both the left and the right.
char
Indicates character alignment. The text is aligned with the first occurrence of the character specified by the @char attribute.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

The @align attribute is available on the following table elements: <colspec>, <entry>, and <tgroup>.

@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@base
Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

The @base attribute takes a space-delimited set of values. However, when serving as a container for generalized attributes, the attribute values will be more complex. See Attribute generalization for more details.

@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@char (complex table attributes)
Specifies the alignment character, which is the character that is used for aligning the text in table entries. This attribute applies when align="char". A value of "" (the null string) means there is no aligning character.

For example, if align="char" and char="." are specified, then text in the table entry aligns with the first occurrence of the period within the entry. This might be useful if decimal alignment is required.

The @char attribute is available on the following table elements: <colspec> and <entry>.

@charoff (complex table attributes)
Specifies the horizontal offset of the alignment character that is specified by the @char attribute. The value is a greater-than-zero number that is less than or equal to 100. It represents the percentage of the current column width by which the text is offset to the left of the alignment character.

For example, if align="char", char=".", and charoff="50" are all specified, then text in the table entry is aligned 50% of the distance to the left of the first occurrence of the period character within the table entry.

The @charoff attribute is available on the following table elements: <colspec> and <entry>.

@class (not for use by authors)
This attribute is not for use by authors. If an editor displays @class attribute values, do not edit them. Specifies a default value that defines the specialization ancestry of the element. Its predefined values allow DITA tools to work correctly with specialized elements. In a generalized DITA document the @class attribute value in the generalized instance might differ from the default value for the @class attribute for the element as given in the DTD or schema. See The class attribute rules and syntax for more information. This attribute is specified on every element except for the <dita> container element. It is always specified with a default value, which varies for each element.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colsep (complex table attributes)
Specifies whether to render column separators between table entries. The following values are valid: 0 (no separators) and 1 (separators).

The @colsep attribute is available on the following table elements: <colspec>, <entry>, <table>, and <tgroup>.

@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@conaction
Specifies how the element content will be pushed into a new location. The following values are valid:
mark
The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter
Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore
Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace
Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See Pushing reusable content to a new location for examples and details about the syntax.

@conkeyref
Specifies a key name or a key name with an element ID that acts as an indirect reference to reusable content. The referenced content is used in place of the content of the current element. See Indirect key-based content reuse for more details about the syntax and behaviors.
@conref
Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See Direct URI-based content reuse for examples and details about the syntax.
@conrefend
Specifies a URI that references the last element in a sequence of elements, with the first element of the sequence specified by @conref. The referenced sequence of elements is used in place of the content of the current element. See Reusing a range of elements for examples and details about the syntax.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@dir

Identifies or overrides the text directionality. The following values are valid:

lro
Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into left-to-right mode.
ltr
Indicates left-to-right.
rlo
Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into right-to-left mode.
rtl
Indicates right-to-left.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The dir attribute for more information.

@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@id
Specifies an identifier for the current element. This ID is the target for references by @href and @conref attributes and for external applications that refer to DITA or LwDITA content. This attribute is defined with the XML data type NMTOKEN, except where noted for specific elements within the language reference.

See id attribute for more details.

@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a role that the element is playing. The role must be consistent with the basic semantic and expectations for the element. In particular, the @outputclass attribute can be used for styling during output processing; HTML output will typically preserve @outputclass for CSS processing.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowheader (complex table attributes)
Specifies whether the entries in the respective column are row headers. The following values are valid:
firstcol
Indicates that entries in the first column of the table are row headers. This applies when the @rowheader attribute is specified on the <table> element.
headers
Indicates that entries of the column that is described using the <colspec> element are row headers. This applies when the @rowheader attribute is specified on the <colspec> element.
norowheader
Indicates that entries in the first column are not row headers. This applies when the @rowheader attribute is specified on the <table> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Note (non-normative):
This attribute is not part of the OASIS Exchange Table Model upon which DITA tables are based. Some processors or output formats might not support all values.

The @rowheader attribute is available on the following table elements: <table> and <colspec>.

@rowsep (complex table attributes)
Specifies whether to render row separators between table entries. The following values are valid: 0 (no separators) and 1 (separators).

The @rowsep attribute is available on the following table elements: <colspec>, <entry>, <row>, <table>, and <tgroup>.

@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate
Specifies whether the content of the element should be translated. The following values are valid: yes, no, and -dita-use-conref-target.

See Element-by-element recommendations for translators for suggested processing defaults for each element.

@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@xml:lang
Specifies the language and optional locale of the content that is contained in an element. Valid values are language tokens or the null string. The @xml:lang attribute and its values are described in the Extensible Markup Language 1.0 specification, fifth edition.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <table>.

<entry>

A table entry represents a single cell in a table that is based on the OASIS Exchange Table Model.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <sl> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<row>

Zero or more of the following

Contained by

Inheritance

- topic/entry

The <entry> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: ID and conref attributes, localization attributes, @align, @base, @char, @charoff, @class, @colsep, @outputclass, @rev, @rowsep, @valign, and the attributes defined below.

@colname
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@morerows
Specifies the number of additional rows to add in a vertical span.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of text in table entries. The following values are valid:
left
Indicates left alignment of the text.
right
Indicates right alignment of the text.
center
Indicates center alignment of the text.
justify
Justifies the contents to both the left and the right.
char
Indicates character alignment. The text is aligned with the first occurrence of the character specified by the @char attribute.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

The @align attribute is available on the following table elements: <colspec>, <entry>, and <tgroup>.

@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@base
Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

The @base attribute takes a space-delimited set of values. However, when serving as a container for generalized attributes, the attribute values will be more complex. See Attribute generalization for more details.

@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@char (complex table attributes)
Specifies the alignment character, which is the character that is used for aligning the text in table entries. This attribute applies when align="char". A value of "" (the null string) means there is no aligning character.

For example, if align="char" and char="." are specified, then text in the table entry aligns with the first occurrence of the period within the entry. This might be useful if decimal alignment is required.

The @char attribute is available on the following table elements: <colspec> and <entry>.

@charoff (complex table attributes)
Specifies the horizontal offset of the alignment character that is specified by the @char attribute. The value is a greater-than-zero number that is less than or equal to 100. It represents the percentage of the current column width by which the text is offset to the left of the alignment character.

For example, if align="char", char=".", and charoff="50" are all specified, then text in the table entry is aligned 50% of the distance to the left of the first occurrence of the period character within the table entry.

The @charoff attribute is available on the following table elements: <colspec> and <entry>.

@class (not for use by authors)
This attribute is not for use by authors. If an editor displays @class attribute values, do not edit them. Specifies a default value that defines the specialization ancestry of the element. Its predefined values allow DITA tools to work correctly with specialized elements. In a generalized DITA document the @class attribute value in the generalized instance might differ from the default value for the @class attribute for the element as given in the DTD or schema. See The class attribute rules and syntax for more information. This attribute is specified on every element except for the <dita> container element. It is always specified with a default value, which varies for each element.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colsep (complex table attributes)
Specifies whether to render column separators between table entries. The following values are valid: 0 (no separators) and 1 (separators).

The @colsep attribute is available on the following table elements: <colspec>, <entry>, <table>, and <tgroup>.

@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@conaction
Specifies how the element content will be pushed into a new location. The following values are valid:
mark
The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter
Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore
Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace
Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See Pushing reusable content to a new location for examples and details about the syntax.

@conkeyref
Specifies a key name or a key name with an element ID that acts as an indirect reference to reusable content. The referenced content is used in place of the content of the current element. See Indirect key-based content reuse for more details about the syntax and behaviors.
@conref
Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See Direct URI-based content reuse for examples and details about the syntax.
@conrefend
Specifies a URI that references the last element in a sequence of elements, with the first element of the sequence specified by @conref. The referenced sequence of elements is used in place of the content of the current element. See Reusing a range of elements for examples and details about the syntax.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@dir

Identifies or overrides the text directionality. The following values are valid:

lro
Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into left-to-right mode.
ltr
Indicates left-to-right.
rlo
Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into right-to-left mode.
rtl
Indicates right-to-left.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The dir attribute for more information.

@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@id
Specifies an identifier for the current element. This ID is the target for references by @href and @conref attributes and for external applications that refer to DITA or LwDITA content. This attribute is defined with the XML data type NMTOKEN, except where noted for specific elements within the language reference.

See id attribute for more details.

@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a role that the element is playing. The role must be consistent with the basic semantic and expectations for the element. In particular, the @outputclass attribute can be used for styling during output processing; HTML output will typically preserve @outputclass for CSS processing.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rev
Specifies a revision level of an element that identifies when the element was added or modified. It can be used to flag outputs when it matches a run-time parameter. It cannot be used for filtering nor is it sufficient to be used for version control. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowsep (complex table attributes)
Specifies whether to render row separators between table entries. The following values are valid: 0 (no separators) and 1 (separators).

The @rowsep attribute is available on the following table elements: <colspec>, <entry>, <row>, <table>, and <tgroup>.

@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate
Specifies whether the content of the element should be translated. The following values are valid: yes, no, and -dita-use-conref-target.

See Element-by-element recommendations for translators for suggested processing defaults for each element.

@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@valign (complex table attributes)
Specifies the vertical alignment of text in table entries. The following values are valid:
bottom
Indicates that text is aligned with the bottom of the table entry.
middle
Indicates that text is aligned with the middle of the table entry.
top
Indicates that text is aligned with the top of the table entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

The @valign attribute is available on the following table elements: <entry>, <tbody>, <thead>, and <row>.

@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@xml:lang
Specifies the language and optional locale of the content that is contained in an element. Valid values are language tokens or the null string. The @xml:lang attribute and its values are described in the Extensible Markup Language 1.0 specification, fifth edition.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <table>.

<row>

A table row is a single row in a table that is based on the OASIS Exchange Table Model.

Content model

<entry> +

Contained by

<tbody> , <thead>

One or more <entry>

Contained by

Inheritance

- topic/row

The <row> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @rowsep and @valign.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowsep (complex table attributes)
Specifies whether to render row separators between table entries. The following values are valid: 0 (no separators) and 1 (separators).

The @rowsep attribute is available on the following table elements: <colspec>, <entry>, <row>, <table>, and <tgroup>.

@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@valign (complex table attributes)
Specifies the vertical alignment of text in table entries. The following values are valid:
bottom
Indicates that text is aligned with the bottom of the table entry.
middle
Indicates that text is aligned with the middle of the table entry.
top
Indicates that text is aligned with the top of the table entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

The @valign attribute is available on the following table elements: <entry>, <tbody>, <thead>, and <row>.

@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <table>.

<simpletable>

A simple table is a basic tabular environment that is designed to present organized content.

Usage information

The <simpletable> element is designed for close compatibility with HTML5 tables. It can contain a title and allows column and row spanning. The @keycol attribute indicates the key column. A key column contains content that represents the key to the tabular structure.

The <simpletable> element can also be used as the base for specialized structures, such as the property and choice tables that are available in the Technical Content edition.

Rendering expectations

When a key column is specified for a simple table, it is treated as a vertical header.

Content model

<title> ?, <sthead> ?, <strow> +

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <div> , <draft-comment> , <example> , <fig> , <howtoavoid> , <li> , <lq> , <note> , <p> , <section>

In order
  1. Optional <title>
  2. Optional <sthead>
  3. One or more <strow>

Contained by

Inheritance

- topic/simpletable

The <simpletable> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: display attributes, simpletable attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@expanse (display attributes)
Specifies the horizontal placement of the element. The following values are valid:
column
Indicates that the element is aligned with the current column margin.
page
Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
spread
Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
textline
Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

For <table>, in place of the @expanse attribute that is used by other DITA elements, the @pgwide attribute is used in order to conform to the OASIS Exchange Table Model.

Some processors or output formats might not support all values.

@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@frame (display attributes)
Specifies which portion of a border surrounds the element. The following values are valid:
all
Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
bottom
Indicates that a line is rendered at the bottom of the containing element.
none
Indicates that no lines are rendered.
sides
Indicates that a line is rendered at the left and right of the containing element.
top
Indicates that a line is rendered at the top of the containing element.
topbot
Indicates that a line is rendered at the top and bottom of the containing element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

Some processors or output formats might not support all values.

@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keycol (simpletable attributes)
Specifies the column that contains the content that represents the key to the tabular structure. If @keycol is present and assigned a numerical value, the specified column is treated as a vertical header.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@relcolwidth (simpletable attributes)
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.

For example, the value relcolwidth="1* 2* 3*" gives a total of 6 units across three columns. The relative widths are 1/6, 2/6, and 3/6 (16.7%, 33.3%, and 50%). Similarly, the value relcolwidth="90* 150*" causes relative widths of 90/240 and 150/240 (37.5% and 62.5%).

@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

Specifies the percentage by which fonts are resized in relation to the normal text size. The value of this attribute is a positive integer. When used on <table> or <simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.

This attribute is primarily useful for print-oriented display. Some processors might not support all values.

If the @scale attribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the <image> element.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <simpletable> element can be used.

Example 48. Example of a simple table

The following code sample shows a simple table that contains menu items and prices:

<simpletable>
  <sthead>
    <stentry>Menu item</stentry>
    <stentry>Price</stentry>
  </sthead>
  <strow>
    <stentry>Apple pie</stentry>
    <stentry>$7.00</stentry>
  </strow>
  <strow>
    <stentry>Cheese sandwich</stentry>
    <stentry>$10.00</stentry>
  </strow>
  <strow>
    <stentry>Milk shake</stentry>
    <stentry>$6.50</stentry>
  </strow>
</simpletable>

The simple table might be rendered in the following way:


The image shows a two-column table. The first column lists menu items, and the second column lists prices. The header row is shaded with green, and the text in the header row is bold. The edges of the screen capture are tattered, to indicate that the image is part of a larger document.
Example 49. Example of a simple table with column and row spanning

The following code sample shows a simple table that tracks meals. The table has a title and column and row spans.

<simpletable>
  <title>Food log for Wednesday</title>
  <sthead>
    <stentry>Meal</stentry>
    <stentry>Food</stentry>
  </sthead>
  <strow>
    <stentry colspan="2">Fasting period</stentry>
  </strow>
  <strow>
    <stentry>Lunch</stentry>
    <stentry rowspan="2">Pasta</stentry>
  </strow>
  <strow>
    <stentry>Dinner</stentry>
  </strow>
</simpletable>

The simple table might be rendered in the following way:


The image shows a two-column table. The first column lists the meal, and the second column lists food eaten. The first row contains the text "Fasting period," and it spans two columns. The next two rows are for "Lunch" and "Dinner". The second cell in both rows contains the text "Pasta," and it spans two rows. The header row is shaded with green, and the text in the header row is bold. The edges of the screen capture are tattered, to indicate that the image is part of a larger document.
Example 50. Example of a simple table that uses @keycol

The following code sample shows a simple table that contains information about the caloric content and prices of menu items. The @keycol attribute indicates that the first column, which contains the menu items, is the key column.

<simpletable keycol="1">
  <sthead>
    <stentry>Menu item</stentry>
    <stentry>Calories</stentry>
    <stentry>Price</stentry>
  </sthead>
  <strow>
    <stentry>Chicken dish</stentry>
    <stentry>850</stentry>
    <stentry>$12.00</stentry>
  </strow>
  <strow>
    <stentry>Vegetarian dish</stentry>
    <stentry>525</stentry>
    <stentry>$9.00</stentry>
  </strow>
  <strow>
    <stentry>Vegan dish</stentry>
    <stentry>475</stentry>
    <stentry>$7.00</stentry>
  </strow>
</simpletable>

This simple table might be rendered in the following way:


The image shows a three-column table. The first column lists menu items, the second column lists calories, and the third column lists price. The header row is shaded with green, and the text in the header row is bold. In addition, the contents of the first column are highlighted in bold, to indicate that the first column serves as a vertical header. The edges of the screen capture are tattered, to indicate that the image is part of a larger document.

In the sample rendering, the content of the key column is highlighted with bold formatting. However, note that rendering of the key column is left up to the implementation.

<stentry>

A simple table entry represents a single cell within a simple table.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <sl> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Contained by

<sthead> , <strow>

Zero or more of the following

Contained by

Inheritance

- topic/stentry

The <stentry> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: table accessibility attributes, universal attributes, and the attributes defined below.

@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <simpletable>.

<sthead>

A simple table header is an optional header row for a simple table.

Usage information
Content model

<stentry> +

Contained by

<simpletable>

One or more <stentry>

Contained by

Inheritance

- topic/sthead

The <sthead> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <simpletable>.

<strow>

A simple table row is a single row in a simple table.

Content model

<stentry> *

Contained by

<simpletable>

Zero or more <stentry>

Contained by

Inheritance

- topic/strow

The <strow> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <simpletable>.

<table>

A table based on the OASIS Exchange Table Model organizes arbitrarily complex relationships of tabular information. This standard table markup provides a wide variety of controls over the display properties of the data and even the table structure itself.

Usage information

The <table> element is based on the OASIS Exchange Table Model. However, it is augmented with DITA attributes that enable accessibility, content reference, specialization, and more.

An optional <title> inside the <table> element provides a caption to describe the table. In addition, the optional <desc> element enables a table description.

See simpletable for a simplified table model that is closely aligned with the HTML5 table model, and which can be easily specialized.

For <table>, in place of the @expanse attribute that is used by other DITA elements, the @pgwide attribute is used in order to conform to the OASIS Exchange Table Model.

Rendering expectations

If a <table> element contains a <desc> element, the content of the <desc> element is rendered as part of the content flow.

Content model

<title> ?, <desc> ?, <tgroup> +

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <div> , <draft-comment> , <example> , <li> , <lq> , <note> , <p> , <section>

In order
  1. Optional <title>
  2. Optional <desc>
  3. One or more <tgroup>

Contained by

Inheritance

- topic/table

The <table> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @colsep, @frame, @rowheader, @rowsep, @scale, and the attributes defined below.

@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colsep (complex table attributes)
Specifies whether to render column separators between table entries. The following values are valid: 0 (no separators) and 1 (separators).

The @colsep attribute is available on the following table elements: <colspec>, <entry>, <table>, and <tgroup>.

@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@frame (display attributes)
Specifies which portion of a border surrounds the element. The following values are valid:
all
Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
bottom
Indicates that a line is rendered at the bottom of the containing element.
none
Indicates that no lines are rendered.
sides
Indicates that a line is rendered at the left and right of the containing element.
top
Indicates that a line is rendered at the top of the containing element.
topbot
Indicates that a line is rendered at the top and bottom of the containing element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

Some processors or output formats might not support all values.

@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowheader (complex table attributes)
Specifies whether the entries in the respective column are row headers. The following values are valid:
firstcol
Indicates that entries in the first column of the table are row headers. This applies when the @rowheader attribute is specified on the <table> element.
headers
Indicates that entries of the column that is described using the <colspec> element are row headers. This applies when the @rowheader attribute is specified on the <colspec> element.
norowheader
Indicates that entries in the first column are not row headers. This applies when the @rowheader attribute is specified on the <table> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Note (non-normative):
This attribute is not part of the OASIS Exchange Table Model upon which DITA tables are based. Some processors or output formats might not support all values.

The @rowheader attribute is available on the following table elements: <table> and <colspec>.

@rowsep (complex table attributes)
Specifies whether to render row separators between table entries. The following values are valid: 0 (no separators) and 1 (separators).

The @rowsep attribute is available on the following table elements: <colspec>, <entry>, <row>, <table>, and <tgroup>.

@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

Specifies the percentage by which fonts are resized in relation to the normal text size. The value of this attribute is a positive integer. When used on <table> or <simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.

This attribute is primarily useful for print-oriented display. Some processors might not support all values.

If the @scale attribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the <image> element.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a table that is used to provide reference information about animals and gestation:

<table>
  <tgroup cols="2">
    <colspec colwidth="121*"/>
    <colspec colwidth="76*"/>
    <thead>
      <row>
        <entry valign="top">Animal</entry>
        <entry valign="top">Gestation (in months)</entry>
      </row>
    </thead>
    <tbody>
      <row>
        <entry>Elephant (African and Asian)</entry>
        <entry>19-22</entry>
      </row>
      <row>
        <entry>Giraffe</entry>
        <entry>15</entry>
      </row>
      <row>
        <entry>Rhinoceros</entry>
        <entry>14-16</entry>
      </row>
      <row>
        <entry>Hippopotamus</entry>
        <entry>7 1/2</entry>
      </row>
    </tbody>
  </tgroup>
</table>

The formatted output might be rendered in the following way:


The image shows a two-column table. The first column lists animals, and the second column lists gestation (in months). The header row is shaded with green, and the text in the header row is bold. The edges of the screen capture are tattered, to indicate that the image is part of a larger document.

In this example, the use of the <thead> element for the header enables processors or screen readers to identify a header relationship between any cell in the table body and the matching header cell above that column.

<tbody>

A table body is a collection of rows in a table that is based on the OASIS Exchange Table Model. It contains the table rows that contain content.

Content model

<row> +

Contained by

<tgroup>

One or more <row>

Contained by

Inheritance

- topic/tbody

The <tbody> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @valign.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@valign (complex table attributes)
Specifies the vertical alignment of text in table entries. The following values are valid:
bottom
Indicates that text is aligned with the bottom of the table entry.
middle
Indicates that text is aligned with the middle of the table entry.
top
Indicates that text is aligned with the top of the table entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

The @valign attribute is available on the following table elements: <entry>, <tbody>, <thead>, and <row>.

@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <table>.

<tgroup>

A table group is a grouping element that contains column specifications, a table header, and the table body in a table that is based on the OASIS Exchange Table Model.

Content model

<colspec> *, <thead> ?, <tbody>

Contained by

<table>

In order
  1. Zero or more <colspec>
  2. Optional <thead>
  3. <tbody>

Contained by

Inheritance

- topic/tgroup

The <tgroup> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes, @align, @colsep, @rowsep, and the attribute defined below.

@cols (REQUIRED)
Specifies the number of columns in a table group.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of text in table entries. The following values are valid:
left
Indicates left alignment of the text.
right
Indicates right alignment of the text.
center
Indicates center alignment of the text.
justify
Justifies the contents to both the left and the right.
char
Indicates character alignment. The text is aligned with the first occurrence of the character specified by the @char attribute.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

The @align attribute is available on the following table elements: <colspec>, <entry>, and <tgroup>.

@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colsep (complex table attributes)
Specifies whether to render column separators between table entries. The following values are valid: 0 (no separators) and 1 (separators).

The @colsep attribute is available on the following table elements: <colspec>, <entry>, <table>, and <tgroup>.

@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowsep (complex table attributes)
Specifies whether to render row separators between table entries. The following values are valid: 0 (no separators) and 1 (separators).

The @rowsep attribute is available on the following table elements: <colspec>, <entry>, <row>, <table>, and <tgroup>.

@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See table.

<thead>

A table header contains one or more header rows in a table that is based on the OASIS Exchange Table Model.

Usage information
Content model

<row> +

Contained by

<tgroup>

One or more <row>

Contained by

Inheritance

- topic/thead

The <thead> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and @valign.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@valign (complex table attributes)
Specifies the vertical alignment of text in table entries. The following values are valid:
bottom
Indicates that text is aligned with the bottom of the table entry.
middle
Indicates that text is aligned with the middle of the table entry.
top
Indicates that text is aligned with the top of the table entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

The @valign attribute is available on the following table elements: <entry>, <tbody>, <thead>, and <row>.

@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <table>.

Map elements

Map elements include the core components of DITA maps, such as the <topicref> and <reltable> elements.

Basic map elements

DITA maps are built from a few core elements that are used for referencing and organizing topics. In addition, the <topicmeta> element can be used to specify metadata for the map, individual topics, or groups of topics.

<keytext>

Key text is variable or link text that is used when resolving key references. It also specifies alternate text for images that are referenced by keys.

Processing expectations

See Processing key references to generate text or link text.

Content model

(Text | <cite> | <data> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> )*

Contained by

<topicmeta>

Zero or more of the following

Contained by

Inheritance

- map/keytext

The <keytext> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <keytext> element can be used.

Example 51. Simple example

The following code sample shows a variable-text definition that includes highlighting elements:

<keydef keys="company-name">
  <topicmeta>
    <keytext translate="no">
      <i>Super</i> Widget Squared<sup>2</sup>
    </keytext>
  </topicmeta>
</keydef>
Example 52. Alternate text for an image

DITA implementations often reference images using keys. In such cases, the <keytext> element provides the alternate text for the image. The following code sample shows the markup for the <keytext> element:

<keydef keys="company-logo" href="images/logo.jpg" format="jpg">
  <topicmeta>
    <keytext>Acme Widgets logo</keytext>
  </topicmeta>
</keydef>

The image can be referenced by <image keyref="company-logo"/>. When rendered to mediums that support alternate text, the effective alternative text for the image is "Acme Widgets logo" as though a literal <alt> element had been a child of the <image>.

Example 53. Processing logic

The following code sample shows a key definition that includes several elements within the <topicmeta> element:

<keydef href="http://www.example.com" keys="company-name" format="html" scope="external">
  <topicmeta>
    <keytext>Acme Tools</keytext>
    <navtitle>Acme Tools web site</navtitle>
    <linktitle>Acme Tools Web Portal</linktitle>
  </topicmeta>
</keydef>

Once processed, the effective text content of both <ph keyref="company-name"/> and <xref keyref="company-name"/> is Acme Tools. This is because of the rules for how processors resolve key references to generate text or link text.

To set distinct text values for both the company name and the link text that is associated with the company Web site, use two different keys.

<map>

A DITA map is the mechanism for aggregating topic references and defining a context for those references. It contains references to topics, maps, and other resources. These references are organized into hierarchies, groups, and tables.

Usage information

A map describes the relationships among a set of DITA topics. The following are some types of relationships that can be described in a map:

Hierarchical
Nested topics create a hierarchical relationship. The topic that does the nesting is the parent, and the topics that are nested are the children.
Ordered
Child topics can be labeled as having an ordered relationship, which means they are referenced in a definite sequence.
Family
Child topics can be labeled as having a family relationship, which means they all refer to each other.

In addition, a DITA map can contain relationship tables. Relationship tables can define relationships between resources that are not directly related based on their location in the navigation structure.

The <title> element can be used to provide a title for the map. In some scenarios the title is purely informational and is present only as an aid to the author. In other scenarios, the title might be useful or even required. In a map referenced by another map, the title might be discarded as topics from the submap are aggregated into a larger publication.

Rendering expectations

When rendering a map, processors might make use of the relationships defined in the map to create a table of contents (TOC), aggregate topics into a PDF document, or create links between topics in the output.

Processing expectations

See DITA map processing.

Content model

<title> ?, <topicmeta> ?, ( <data> | <navref> | <reltable> | <topicref> | <ditavalref> | <keydef> | <mapref> | <mapresources> | <topicgroup> | <topichead> )*

Not contained by any element.

In order
  1. Optional <title>
  2. Optional <topicmeta>
  3. Zero or more of the following

Not contained by any element.

Inheritance

- map/map

The <map> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: architectural attributes, common map attributes, universal attributes, @format, @scope, and @type.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@DITAArchVersion (architectural attributes)
Specifies the version of the DITA architecture that is in use. This attribute is in the namespace http://dita.​oasis-open.​org/​architecture/​2005/. This attribute is specified in the topic and map modules, and it uses a default value of the current version of DITA. The current default is 2.0.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@specializations (architectural attributes)
Specifies the attribute-domain specializations that are included in the document-type shell. This attribute is set as a default within the document-type shell. The value varies depending on what domains are integrated into the document-type shell. For example, a grammar file that includes the specialized attributes @audience, @deliveryTarget, and @newBaseAtt would set the value to @props/audience @props/deliveryTarget @base/newBaseAtt.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample contains four <topicref> elements. The <topicref> elements are nested and so have a hierarchical relationship. The file widget.dita is the parent topic, and the other topics are its children. The hierarchy could be used to generate a PDF, a navigation pane in a web-based information system, a summary of the topics, or related links between the parent topic and its children.

<map id="widget-setup">
  <title>Widget set up</title>
  <topicref href="widget.dita">
    <topicref href="widget-installation.dita"/>
    <topicref href="widget-configuration.dita"/>
    <topicref href="widget-integration.dita"/>
  </topicref>
</map>

<relcell>

A cell in a relationship table is a group of one or more topic references that are related to the topic references in other cells of the same row.

Usage information

A relationship table cell does not imply a relationship between topics or resources that are referenced in the same cell, unless the @collection-type attribute set on the cell indicates that they are related.

Content model

( <topicref> | <ditavalref> | <keydef> | <mapref> | <mapresources> | <topicgroup> | <topichead> | <data> )*

Contained by

<relrow>

Zero or more of the following

Contained by

Inheritance

- map/relcell

The <relcell> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: common map attributes (without @keyscope), universal attributes, @format, @scope, and @type.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <reltable>.

<relcolspec>

A column specification in a relationship table column that provides default attribute values for the references in that column of a relationship table.

Usage information

You can use the <relcolspec> element to set default values for the attributes of the topics that are referenced in the column. For example, when you set the @type attribute to concept, all <topicref> elements in the column that do not have a @type attribute specified are treated as concepts.

Adding a <topicref> element to the <relcolspec> element defines a relationship between the topics that are contained within the <relcolspec> element and the topics that are referenced in the column of the relationship table. Note that this does not define a relationship between two cells in the same column.

Rendering expectations
When a <title> element exists inside of the <relcolspec> element, the content of the <title> element is intended to be used as the label for the related links that are defined and generated by the column. If the <title> element is not present, the labels for the related links are generated in the following ways:
  • If the <relcolspec> element contains a <topicref> element that specifies a navigation title, that navigation title is used for the label.
  • If the <relcolspec> element contains a <topicref> element that does not specify a navigation title but does reference a DITA topic, the label is derived from the navigation title of the referenced topic or, lacking that, the title of the topic.
  • If no title is specified and no <topicref> is present in the <relcolspec>, a rendering tool might choose to generate a title for the links generated from that column.
Processing expectations

When values are specified for attributes of <relcell> or <relrow> elements, those values override those defined for <relcolspec> attributes. Values specified for attributes of <relcolspec> elements override those defined for the <reltable> element.

Content model

<title> ?, <topicmeta> ?, ( <topicref> | <ditavalref> | <keydef> | <mapref> | <mapresources> | <topicgroup> | <topichead> )*

Contained by

<relheader>

In order
  1. Optional <title>
  2. Optional <topicmeta>
  3. Zero or more of the following

Contained by

Inheritance

- map/relcolspec

The <relcolspec> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: universal attributes and common map attributes (without @keyscope or @collection-type), @type, @scope, and @format.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

The following section contains examples of how the <relcolspec> element can be used.

Example 54. Enforcing concept, type, and reference types with <relcolspec>

The following code sample shows how a <relcolspec> element can be used to define the types of topics that are referenced in a column. Three cells are defined within one row. The first cell contains one concept topic: puffins.dita. The second cell contains two task topics: puffinFeeding.dita and puffinCleaning.dita. The third cell contains a reference topic: puffinHistory.dita. Setting the @type on each column allows (but does not require) processors to validate that the topics in each column are of the expected type.

<map>
 <reltable>
  <relheader>
   <relcolspec type="concept"/>
   <relcolspec type="task"/>
   <relcolspec type="reference"/>
  </relheader>
  <relrow>
   <relcell><topicref href="puffins.dita"/></relcell>
   <relcell>
     <topicref href="puffinFeeding.dita"/>
     <topicref href="puffinCleaning.dita"/>
   </relcell>
   <relcell>
     <topicref href="puffinHistory.dita"/>
   </relcell>
  </relrow>
 </reltable>
</map>
Example 55. Relationship table column headers with topics and titles

The following code sample shows how topics and titles can be specified in a column header for relationship table column header: 

<reltable>
  <relheader>
    <relcolspec type="task">
      <topicref href="tbs.dita">
        <topicmeta><navtitle>Troubleshooting</navtitle></topicmeta>
      </topicref>
    </relcolspec>
    <relcolspec type="reference">
      <topicref href="msg.dita">
        <topicmeta><navtitle>Messages</navtitle></topicmeta>
      </topicref>
    </relcolspec>
  </relheader>
  <relrow>
    <relcell>
      <topicref href="debug_login.dita"/>
        <topicmeta><linktitle>Debugging login errors</linktitle></topicmeta>
      </topicref>
    </relcell>
    <relcell>
      <topicref href="login_error_1.dita">
        <topicmeta><linktitle>Login not found</linktitle></topicmeta>
      </topicref>
    </relcell>
  </relrow>
  <relrow>
    <relcell>
      <topicref href="checking_access.dita">
        <topicmeta><linktitle>Checking access controls</linktitle></topicmeta>
      </topicref>
    </relcell>
    <relcell>
      <topicref href="login_error_2.dita">
        <topicmeta><linktitle>Login not allowed</linktitle></topicmeta>
      </topicref>
    </relcell>
  </relrow>
</reltable>
In addition to the relationships defined by the rows in the relationship table, the following relationships are now defined by the columns in the relationship table:
  • tbs.dita <–> debug_login.dita
  • tbs.dita <–> checking_access.dita
  • msg.dita <–> login_error_1.dita
  • msg.dita <–> login_error_2.dita

Ignoring the headers for a moment, the <reltable> here would ordinarily define a two-way relationship between debug_login.dita and login_error1.dita. This typically will be expressed as a link from each to the other. An application might render the link with a language-appropriate heading such as "Related reference", indicating that the target of the link is a reference topic.

The headers change this by specifying a new title. In the second column, the <topicref> specifies a title of "Messages", which should now be used together with the link to anything in that column. So, a generated link from debug_login.dita to login_error1.dita should be rendered together with the title of "Messages". How this is rendered together with the link is up to the application.

<relheader>

A header row in a relationship table is a group of column definitions for a relationship table.

Content model

<relcolspec> +

Contained by

<reltable>

One or more <relcolspec>

Contained by

Inheritance

- map/relheader

The <relheader> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <reltable>.

<relrow>

A row in a relationship table creates a relationship between the cells in that row, which is often expressed in output as links between the topics or resources that are referenced in those cells.

Content model

<relcell> *

Contained by

<reltable>

Zero or more <relcell>

Contained by

Inheritance

- map/relrow

The <relrow> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <reltable>.

<reltable>

A relationship table is a mechanism that creates relationships among topics, based on the familiar table model of rows, columns, and cells.

Usage information

Relationship tables can be used in conjunction with hierarchies and groups to manage all the related links in an information set.

Each column in a relationship table typically represents a specific role in a set of relationships, and each row defines relationships between the resources that are referenced in the different cells of that row.

A frequently-used type of relationship table uses the following structure:

  • The first column contains references to task topics.
  • The second column contains references to concept topics.
  • The third column contains references to reference topics.

Such a relationship table establishes relationships between task topics and the concept and reference topics that support the tasks. It help authors and architects determine where related information is missing or undefined.

When a title is associated with a relationship table, the title typically is used as an authoring convenience and is not displayed in generated publications.

Processing expectations

By default, the contents of a <reltable> element are not rendered in a table of contents; they are used only to define relationships that can be expressed as topic-to-topic links. The <relcell> elements can contain <topicref> elements, which are then related to other <topicref> elements in the same row (although not necessarily in the same cell).

Within a root map, the effective relationship table is the union of all relationship tables in the map hierarchy.

Content model

<title> ?, <topicmeta> ?, <relheader> ?, <relrow> +

Contained by

<map>

In order
  1. Optional <title>
  2. Optional <topicmeta>
  3. Optional <relheader>
  4. One or more <relrow>

Contained by

Inheritance

- map/reltable

The <reltable> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: common map attributes (without @keyscope or @collection-type), universal attributes, @format, @scope, and @type.

For this element, the @toc attribute has a default value of no.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
For this element, the @toc attribute has a default value of no.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In the following code sample, a relationship table is defined with three columns: one for "concept", one for "task", and one for "reference". Three cells are defined within each row. The first cell contains one concept topic: about-MyDevice.dita. The second cell contains two task topics: setting-up-MyDevice.dita and operating-MyDevice.dita. The third cell contains two reference topics: MyDevice-settings.dita and MyDevice-version-info.dita.

<map>
  <reltable>
    <relheader>
      <relcolspec type="concept"/>
      <relcolspec type="task"/>
      <relcolspec type="reference"/>
    </relheader>
    <relrow>
      <relcell>
        <topicref href="about-MyDevice.dita"/>
      </relcell>
      <relcell>
        <topicref href="setting-up-MyDevice.dita"/>
        <topicref href="operating-MyDevice.dita"/>
      </relcell>
      <relcell>
        <topicref href="MyDevice-settings.dita"/>
        <topicref href="MyDevice-version-info.dita"/>
      </relcell>
    </relrow>
  </reltable>
</map>

A graphical version of the relationship table in an editor might look like this:

type="concept" type="task" type="reference"
about-MyDevice.dita

setting-up-MyDevice.dita
operating-MyDevice.dita

MyDevice-settings.dita
MyDevice-version-info.dita

When rendered, links are added to topics that are in the same row, but not in the same cell. This allows simple maintenance of parallel relationships: for example, in this case, setting-up-MyDevice.dita and operating-MyDevice.dita are two tasks that require the same supporting information (concept and reference topics) but might otherwise be unrelated. When topics in the same cell are in fact related, the @collection-type attribute for the cell can be set to family. If some cells or columns are intended solely as supporting information and should not link back to topics in other cells, you can set the @linking attribute on the <relcell> or <relcolspec> to targetonly.

In this example, the related links would be as follows:

about-MyDevice.dita
setting-up-MyDevice.dita, operating-MyDevice.dita, MyDevice-settings.dita, MyDevice-version-info.dita
setting-up-MyDevice.dita
about-MyDevice.dita, MyDevice-settings.dita, MyDevice-version-info.dita
operating-MyDevice.dita
about-MyDevice.dita, MyDevice-settings.dita, MyDevice-version-info.dita
MyDevice-settings.dita
about-MyDevice.dita, setting-up-MyDevice.dita, operating-MyDevice.dita
MyDevice-version-info.dita
about-MyDevice.dita, setting-up-MyDevice.dita, operating-MyDevice.dita

Relationship tables are inherently an efficient way to manage these links. In particular, they increase the prospect for reuse among topics, because those topics do not contain context-specific links. A relationship table also makes it easy to see and manage patterns; for example, the fact that operating-MyDevice.dita and setting-up-MyDevice.dita have the same relationships to supporting information is clear from the table, but would require some comparison and counting to determine from the list summary just before this paragraph.

<topicref>

A topic reference is the mechanism for referencing a topic (or another resource) from a DITA map. It can nest, which enables the expression of navigation and table-of-content hierarchies, as well as containment hierarchies and parent-child relationships.

Content model

<topicmeta> ?, ( <data> | <navref> | <topicref> | <ditavalref> | <keydef> | <mapref> | <mapresources> | <topicgroup> | <topichead> )*

Contained by

<keydef> , <map> , <mapresources> , <relcell> , <relcolspec> , <topicgroup> , <topichead> , <topicref>

In order
  1. Optional <topicmeta>
  2. Zero or more of the following

Contained by

Inheritance

- map/topicref

The <topicref> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, @impose-role, @keyref, and @keys.

For this element, the @href attribute references the resource that is represented by the <topicref>. See The href attribute for detailed information on supported values and processing implications. References to DITA content cannot be below the topic level: that is, you cannot reference individual elements inside a topic. References to content other than DITA topics should use the @format attribute to identify the kind of resource being referenced.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@impose-role
Specifies whether this element will impose its role on elements in a referenced map. The attribute is ignored if the target of the reference is not a map or branch of a map. The following values are valid:
keeptarget
The role of the current reference is not imposed on the target of the reference. This is the default for the unspecialized <topicref> element and for many convenience elements such as <keydef>.
impose
The role of the current reference is imposed on the target of the reference. For example, if a specialized topic reference <chapter> uses this value and references a map, a topic reference that resolves in place of the <chapter> will be treated as if it were a chapter.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The href attribute for detailed information on supported values and processing implications.

@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@keys
Specifies one or more names for a resource. See Setting key names with the keys attribute for information on using this attribute.
Specifies one or more names for a resource. See Setting key names with the keys attribute for information on using this attribute.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a simple map that organizes several topics about the software product "Example Tool Builder". The <topicref> that refers to setup.dita uses the @collection-type attribute to indicate that the order of three children topics in that section is important.

<map>
  <title>Example Tool Builder version 1.2.3</title>
  <topicref href="setup.dita" collection-type="sequence">
    <topicref href="prerequisites.dita"/>
    <topicref href="installing.dita"/>
    <topicref href="validating.dita"/>
  </topicref>
  <topicref href="everyday-use.dita">
    <!-- ... -->
  </topicref>
  <topicref href="troubleshooting.dita">
    <!-- ... -->
  </topicref>
</map>

<topicmeta>

Topic metadata is metadata that applies to a topic based on its context in a map.

Usage information

The metadata specified in a <topicmeta> element is specific to a given context within a map. If a reference to a single resource appears more than once in a map or set of maps, unique metadata can be specified in each instance. For example, when the parent <topicref> element results in a link, elements within the <topicmeta> element can be used to provide context-specific information about the link, such as link text, a short description, or a navigation title.

Content model

<keytext> ?, ( <titlealt> | <navtitle> | <searchtitle> | <linktitle> | <subtitle> | <titlehint> )*, <shortdesc> ?, <author> *, <source> ?, <publisher> ?, <copyright> *, <critdates> ?, <permissions> ?, <metadata> *, <audience> *, <category> *, <keywords> *, <prodinfo> *, <othermeta> *, <resourceid> *, <ux-window> *, ( <data> | <foreign> )*

Contained by

<keydef> , <map> , <mapref> , <mapresources> , <relcolspec> , <reltable> , <topicgroup> , <topichead> , <topicref>

In order
  1. Optional <keytext>
  2. Zero or more of the following
  3. Optional <shortdesc>
  4. Zero or more <author>
  5. Optional <source>
  6. Optional <publisher>
  7. Zero or more <copyright>
  8. Optional <critdates>
  9. Optional <permissions>
  10. Zero or more <metadata>
  11. Zero or more <audience>
  12. Zero or more <category>
  13. Zero or more <keywords>
  14. Zero or more <prodinfo>
  15. Zero or more <othermeta>
  16. Zero or more <resourceid>
  17. Zero or more <ux-window>
  18. Zero or more of the following

Contained by

Inheritance

- map/topicmeta

The <topicmeta> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how the <topicmeta> element can contain a link title and short description:

<map>
  <title>Indexing elements</title>        
  <topicref href="indexing.dita">
    <topicmeta>
      <linktitle>Indexing for company specialists</linktitle>
      <shortdesc>Guidelines for indexing company materials</shortdesc>
    </topicmeta>
    <!-- Additional topic references -->
  </topicref>
</map>

When link previews for indexing.dita are generated, the link title and short description provided within the <topicmeta> element are used.

<ux-window>

A UX window specification is a collection of metadata for a window or viewport in which a user assistance topic or web page can be displayed. The window or viewport can be referenced by the <resourceid> element that is associated with a topic or <topicref> element.

Usage information

The <ux-window> element can be used in any <topicmeta> element in a map. If more than one <ux-window> element in a map has the same @name attribute, the first window specification in document order with that @name attribute is used.

Content model

EMPTY

Contained by

<topicmeta>

Empty

Contained by

Inheritance

- map/ux-window

The <ux-window> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: ID and conref attributes, metadata attributes, @class, and the attributes defined below.

@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@height
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@name (REQUIRED)
Specifies the value used to refer to this window definition.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@width
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@audience (specialized attribute)
Indicates the intended audience for the element. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@base
Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

The @base attribute takes a space-delimited set of values. However, when serving as a container for generalized attributes, the attribute values will be more complex. See Attribute generalization for more details.

@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@class (not for use by authors)
This attribute is not for use by authors. If an editor displays @class attribute values, do not edit them. Specifies a default value that defines the specialization ancestry of the element. Its predefined values allow DITA tools to work correctly with specialized elements. In a generalized DITA document the @class attribute value in the generalized instance might differ from the default value for the @class attribute for the element as given in the DTD or schema. See The class attribute rules and syntax for more information. This attribute is specified on every element except for the <dita> container element. It is always specified with a default value, which varies for each element.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@conaction
Specifies how the element content will be pushed into a new location. The following values are valid:
mark
The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter
Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore
Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace
Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See Pushing reusable content to a new location for examples and details about the syntax.

@conkeyref
Specifies a key name or a key name with an element ID that acts as an indirect reference to reusable content. The referenced content is used in place of the content of the current element. See Indirect key-based content reuse for more details about the syntax and behaviors.
@conref
Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See Direct URI-based content reuse for examples and details about the syntax.
@conrefend
Specifies a URI that references the last element in a sequence of elements, with the first element of the sequence specified by @conref. The referenced sequence of elements is used in place of the content of the current element. See Reusing a range of elements for examples and details about the syntax.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@deliveryTarget (specialized attribute)
Specifies the intended delivery target of the content, for example, html, pdf, or epub. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@id
Specifies an identifier for the current element. This ID is the target for references by @href and @conref attributes and for external applications that refer to DITA or LwDITA content. This attribute is defined with the XML data type NMTOKEN, except where noted for specific elements within the language reference.

See id attribute for more details.

@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@importance
Specifies the importance or priority that is assigned to an element. The following values are valid: default, deprecated, high, low, normal, obsolete, optional, recommended, required, urgent, and -dita-use-conref-target. This attribute is not used for conditional processing, although applications might use the value of the @importance attribute to highlight elements. For example, in steps of a task topic, the value of the @importance attribute indicates whether a step is optional or required.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@otherprops (specialized attribute)
Specifies a property or properties that provide selection criteria for the element. Alternatively, the @props attribute can be specialized to provide a new metadata attribute instead of using the general @otherprops attribute. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@platform (specialized attribute)
Indicates operating system and hardware. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.
@product (specialized attribute)
Specifies the name of the product to which the element applies. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.
@props
Specifies metadata about the element. New attributes can be specialized from the @props attribute. This attribute supports conditional processing. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

The @props attribute takes a space-delimited set of values. However, when serving as a container for generalized attributes, the attribute values will be more complex. See Attribute generalization for more details.

Specifies metadata about the element. New attributes can be specialized from the @props attribute. This attribute supports conditional processing. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

The @props attribute takes a space-delimited set of values. However, when serving as a container for generalized attributes, the attribute values will be more complex. See Attribute generalization for more details.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rev
Specifies a revision level of an element that identifies when the element was added or modified. It can be used to flag outputs when it matches a run-time parameter. It cannot be used for filtering nor is it sufficient to be used for version control. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@status
Specifies the modification status of the element. The following values are valid: new, changed, deleted, unchanged, and -dita-use-conref-target.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section shows how the <ux-window> and <resourceid> elements work together to define and use window definitions.

Example 56. Using <ux-window> with <resourceid>

The following code sample shows how a window with a name of "help" is defined in the map. The window name is later referenced by the @ux-windowref attribute on the <resourceid> element.

<map>
 <title>Widget Help</title>
 <topicmeta>
  <ux-window id="fg23" name="help" top="10" left="20" height="400" width="500" 
     features="status=yes,toolbar=no,menubar=no,location=no" relative="yes"
     full-screen="no" />
 </topicmeta>
 <topicref href="file_ops.dita" type="concept">
   <topicref href="saving.dita" type="task" />
   <topicref href="deleting.dita" type="task" />
   <topicref href="editing.dita" type="task">
     <topicmeta>  
       <resourceid id="ab43" appname="ua" 
          appid="5432" ux-context-string="idh_fileedit" ux-windowref="help" />
     </topicmeta>
   </topicref>
</topicref>
</map>
Example 57. Using multiple <ux-window> definitions

The following code sample shows how multiple window specifications can be defined for alternate presentations, such as desktop computers and tablets:

<map>
 <title>Puggles Help</title>
 <topicmeta>
 <ux-window id="p76" name="ux-tablet" top="1cm" left="1cm" height="4cm" width="3cm" 
    features="status=no,toolbar=no,menubar=no,location=no" relative="no"
    full-screen="no" />
 <ux-window id="p80" name="ux-desktop" top="5cm" left="10cm" height="16cm" width="12cm" 
    features="status=yes,toolbar=no,menubar=no,location=yes" relative="no"
    full-screen="no" />
 </topicmeta>
 <topicref href="c_puggles_intro.dita" type="concept">
  <!-- ... -->
 </topicref>
</map>

Subject scheme elements

Subject scheme elements are used to define sets of controlled values and taxonomic subjects, bind controlled values to attributes as enumerations, and specify relationships among taxonomic subjects.

<attributedef>

The <attributedef> element specifies an attribute that is bound to a set of controlled values. This binding restricts the permissible values for the attribute to the set of controlled values.

Specialization hierarchy

The <attributedef> element is specialized from <data>. It is defined in the subject scheme module.

Content model

<data> **

Contained by

<enumerationdef>

Zero or more Zero or more <data>

Contained by

Inheritance

- topic/data subjectScheme/attributedef

The <attributedef> element is specialized from <data> . It is defined in the subjectScheme module.

Attributes

The following attributes are available on this element: ID and conref attributes, @base, @class, @name, @outputclass, @status, and @translate.

For this element, the following considerations apply:
  • The @name attribute is required. It specifies the name of the attribute to which the controlled values are bound.
  • The @translate attribute has a default value of no.
@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@base
Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

The @base attribute takes a space-delimited set of values. However, when serving as a container for generalized attributes, the attribute values will be more complex. See Attribute generalization for more details.

@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@class (not for use by authors)
This attribute is not for use by authors. If an editor displays @class attribute values, do not edit them. Specifies a default value that defines the specialization ancestry of the element. Its predefined values allow DITA tools to work correctly with specialized elements. In a generalized DITA document the @class attribute value in the generalized instance might differ from the default value for the @class attribute for the element as given in the DTD or schema. See The class attribute rules and syntax for more information. This attribute is specified on every element except for the <dita> container element. It is always specified with a default value, which varies for each element.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@conaction
Specifies how the element content will be pushed into a new location. The following values are valid:
mark
The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter
Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore
Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace
Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See Pushing reusable content to a new location for examples and details about the syntax.

@conkeyref
Specifies a key name or a key name with an element ID that acts as an indirect reference to reusable content. The referenced content is used in place of the content of the current element. See Indirect key-based content reuse for more details about the syntax and behaviors.
@conref
Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See Direct URI-based content reuse for examples and details about the syntax.
@conrefend
Specifies a URI that references the last element in a sequence of elements, with the first element of the sequence specified by @conref. The referenced sequence of elements is used in place of the content of the current element. See Reusing a range of elements for examples and details about the syntax.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@id
Specifies an identifier for the current element. This ID is the target for references by @href and @conref attributes and for external applications that refer to DITA or LwDITA content. This attribute is defined with the XML data type NMTOKEN, except where noted for specific elements within the language reference.

See id attribute for more details.

@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
Defines a unique name for the object.
The @name attribute is required. It specifies the name of the attribute to which the controlled values are bound.
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a role that the element is playing. The role must be consistent with the basic semantic and expectations for the element. In particular, the @outputclass attribute can be used for styling during output processing; HTML output will typically preserve @outputclass for CSS processing.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@status
Specifies the modification status of the element. The following values are valid: new, changed, deleted, unchanged, and -dita-use-conref-target.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate
Specifies whether the content of the element should be translated. The following values are valid: yes, no, and -dita-use-conref-target.

See Element-by-element recommendations for translators for suggested processing defaults for each element.

The @translate attribute has a default value of no.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In the following code sample, the enumeration definition for the @otherprops attribute limits the permissible values to the subject values-otherprops:

<subjectScheme>
    <!-- DEFINE SETS OF CONTROLLED VALUES -->    
    <!-- Values for @otherprops -->
    <subjectdef keys="values-otherprops">
        <subjectdef keys="examples"/>
    </subjectdef>
    
    <!-- BINDS SETS OF CONTROLLED VALUES -->    
    <!-- Binding for @otherprops -->
    <enumerationdef>
        <attributedef name="otherprops"/>
        <subjectdef keyref="values-otherprops"/>
    </enumerationdef>

</subjectScheme>

This means that the only valid value for the @otherprops attribute is examples.

<defaultSubject>

The <defaultSubject> element specifies the default value for the attribute in cases where no value is specified. The default value must be one of the controlled values that are bound to the attribute.

Processing expectations
Specialization hierarchy

The <defaultSubject> element is specialized from <topicref>. It is defined in the subject scheme module.

Content model

<data> **

Contained by

<enumerationdef>

Zero or more Zero or more <data>

Contained by

Inheritance

- map/topicref subjectScheme/defaultSubject

The <defaultSubject> element is specialized from <topicref> . It is defined in the subjectScheme module.

Attributes

The following attributes are available on this element: link-relationship attributes, universal attributes, @impose-role, @keyref, @keys, @processing-role, and @toc.

For this element, the @impose-role attribute has a fixed value of keeptarget.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@impose-role
Specifies whether this element will impose its role on elements in a referenced map. The attribute is ignored if the target of the reference is not a map or branch of a map. The following values are valid:
keeptarget
The role of the current reference is not imposed on the target of the reference. This is the default for the unspecialized <topicref> element and for many convenience elements such as <keydef>.
impose
The role of the current reference is imposed on the target of the reference. For example, if a specialized topic reference <chapter> uses this value and references a map, a topic reference that resolves in place of the <chapter> will be treated as if it were a chapter.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The href attribute for detailed information on supported values and processing implications.

For this element, the @impose-role attribute has a fixed value of keeptarget.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@keys
Specifies one or more names for a resource. See Setting key names with the keys attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample limits the values for @platform to the os subject and sets the default value to linux:

<subjectScheme>
  <subjectdef keys="os">
    <subjectdef keys="linux"/>
    <subjectdef keys="mswin"/>
    <subjectdef keys="zos"/>
    <subjectdef keys="macos"/>
  </subjectdef>
  <enumerationdef>
    <attributedef name="platform"/>
    <subjectdef keyref="os"/>
    <defaultSubject keyref="linux"/>
  </enumerationdef>
</subjectScheme>

The result is that only the following values are permitted for @platform:

  • linux
  • macos
  • mswin
  • zos

If no value is specified for the @platform attribute in the DITA source, the value is assumed to be linux.

<elementdef>

The <elementdef> element specifies an element to which an attribute and set of controlled values are bound.

Specialization hierarchy

The <elementdef> element is specialized from <data>. It is defined in the subject scheme module.

Content model

<data> **

Contained by

<enumerationdef>

Zero or more Zero or more <data>

Contained by

Inheritance

- topic/data subjectScheme/elementdef

The <elementdef> element is specialized from <data> . It is defined in the subjectScheme module.

Attributes

The following attributes are available on this element: ID and conref attributes, @base, @class, @name, @outputclass, @status, and @translate.

For this element, the following considerations apply:
  • The @name attribute is required. It specifies the name of an element to which the controlled attribute values are bound.
  • The @translate attribute has a default value of no.
@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@base
Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

The @base attribute takes a space-delimited set of values. However, when serving as a container for generalized attributes, the attribute values will be more complex. See Attribute generalization for more details.

@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@class (not for use by authors)
This attribute is not for use by authors. If an editor displays @class attribute values, do not edit them. Specifies a default value that defines the specialization ancestry of the element. Its predefined values allow DITA tools to work correctly with specialized elements. In a generalized DITA document the @class attribute value in the generalized instance might differ from the default value for the @class attribute for the element as given in the DTD or schema. See The class attribute rules and syntax for more information. This attribute is specified on every element except for the <dita> container element. It is always specified with a default value, which varies for each element.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@conaction
Specifies how the element content will be pushed into a new location. The following values are valid:
mark
The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter
Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore
Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace
Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See Pushing reusable content to a new location for examples and details about the syntax.

@conkeyref
Specifies a key name or a key name with an element ID that acts as an indirect reference to reusable content. The referenced content is used in place of the content of the current element. See Indirect key-based content reuse for more details about the syntax and behaviors.
@conref
Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See Direct URI-based content reuse for examples and details about the syntax.
@conrefend
Specifies a URI that references the last element in a sequence of elements, with the first element of the sequence specified by @conref. The referenced sequence of elements is used in place of the content of the current element. See Reusing a range of elements for examples and details about the syntax.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@id
Specifies an identifier for the current element. This ID is the target for references by @href and @conref attributes and for external applications that refer to DITA or LwDITA content. This attribute is defined with the XML data type NMTOKEN, except where noted for specific elements within the language reference.

See id attribute for more details.

@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
Defines a unique name for the object.
The @name attribute is required. It specifies the name of an element to which the controlled attribute values are bound.
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a role that the element is playing. The role must be consistent with the basic semantic and expectations for the element. In particular, the @outputclass attribute can be used for styling during output processing; HTML output will typically preserve @outputclass for CSS processing.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@status
Specifies the modification status of the element. The following values are valid: new, changed, deleted, unchanged, and -dita-use-conref-target.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate
Specifies whether the content of the element should be translated. The following values are valid: yes, no, and -dita-use-conref-target.

See Element-by-element recommendations for translators for suggested processing defaults for each element.

The @translate attribute has a default value of no.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In this code sample, the @type attribute for the <note> element is bound to the specified set of values:

<subjectScheme>
  <subjectdef keys="note-values">
    <subjectdef keys="attention"/>
    <subjectdef keys="caution"/>
    <subjectdef keys="danger"/>
  </subjectdef>
  <!-- ... -->
  <enumerationdef>
    <elementdef name="note"/>
    <attributedef name="type"/>
    <subjectdef keyref="note-values"/>
  </enumerationdef>
</subjectScheme>

Processors limit the values for the @type attribute on the <note> element to the following set of values: attention, caution, and danger. Other elements that have a @type attribute are not affected.

<enumerationdef>

An enumeration definition is a binding of an attribute to a set of controlled values. The set of controlled values can be limited to a specific element or it could be empty.

Usage information

An enumeration definition can accomplish the following goals:

Bind a set of controlled values to an attribute
When the <enumerationdef> element contains only an <attributedef> and a <subjectdef> element, the set of controlled values that are bound to the attribute apply to all elements. For example, when <enumerationdef> contains only <attributedef name="value"/>, the @value attribute is limited to the specified enumeration for all elements that can specify the @value attribute.
Limit a set of controlled values to a specific element and attribute pair
When the <enumerationdef> element contains an <attributedef>, a <subjectdef>, and an <elementdef> element, the enumeration applies to the specified attribute only on the specified element. The enumeration does not apply to the attribute on other elements.

For example, when the <enumerationdef> element contains both <attributedef name="type"/> and <elementdef name="note"/>, only the @type attribute on the <note> element is limited to the specified enumeration. The possible values for the @type attribute on other elements are not affected.

Specify the default value for an attribute or element and attribute pair
When the <enumerationdef> element contains a <defaultSubject> element, processors operate as if the value specified by the <defaultSubject> element is explicitly set in the DITA source and the XML grammar does not set a default value for the attribute.

For example, given the following <enumerationdef> element, if no value is set for the @audience attribute on <draft-comment> in the DITA source, processors operate as if the @audience attribute is explicitly set to spec-editors:

<subjectScheme>
  <!-- ... -->
  <enumerationdef>
    <elementdef name="draft-comment"/>
    <attributedef name="audience"/>
    <subjectdef keyref="values-audience-draft-comment"/>
    <defaultSubject keyref="spec-editors"/>
  </enumerationdef>
  <!-- ... -->
</subjectScheme>
Specify that an attribute is not valid.

When the <enumerationdef> element contains a @subjectdef element that does not reference a subject, no value is valid for the attribute.

For example, the following code sample specifies that no tokens are valid for the @props attribute:
<subjectScheme>
  <!-- ... -->
  <enumerationdef>
    <attributedef name="props"/>
    <subjectdef/>
  </enumerationdef>
  <!-- ... -->
</subjectScheme>
Specialization hierarchy

The <enumerationdef> element is specialized from <topicref>. It is defined in the subject scheme module.

Processing expectations

See Determining effective attribute values

Content model

<elementdef> ?, <attributedef> , <subjectdef> +, <defaultSubject> ?, <data> **

Contained by

<subjectScheme>

In order
  1. Optional <elementdef>
  2. <attributedef>
  3. One or more <subjectdef>
  4. Optional <defaultSubject>
  5. Zero or more Zero or more <data>

Contained by

Inheritance

- map/topicref subjectScheme/enumerationdef

The <enumerationdef> element is specialized from <topicref> . It is defined in the subjectScheme module.

Attributes

The following attributes are available on this element: ID and conref attributes, @base, @class, @outputclass, and @status.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@base
Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

The @base attribute takes a space-delimited set of values. However, when serving as a container for generalized attributes, the attribute values will be more complex. See Attribute generalization for more details.

@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@class (not for use by authors)
This attribute is not for use by authors. If an editor displays @class attribute values, do not edit them. Specifies a default value that defines the specialization ancestry of the element. Its predefined values allow DITA tools to work correctly with specialized elements. In a generalized DITA document the @class attribute value in the generalized instance might differ from the default value for the @class attribute for the element as given in the DTD or schema. See The class attribute rules and syntax for more information. This attribute is specified on every element except for the <dita> container element. It is always specified with a default value, which varies for each element.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@conaction
Specifies how the element content will be pushed into a new location. The following values are valid:
mark
The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter
Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore
Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace
Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See Pushing reusable content to a new location for examples and details about the syntax.

@conkeyref
Specifies a key name or a key name with an element ID that acts as an indirect reference to reusable content. The referenced content is used in place of the content of the current element. See Indirect key-based content reuse for more details about the syntax and behaviors.
@conref
Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See Direct URI-based content reuse for examples and details about the syntax.
@conrefend
Specifies a URI that references the last element in a sequence of elements, with the first element of the sequence specified by @conref. The referenced sequence of elements is used in place of the content of the current element. See Reusing a range of elements for examples and details about the syntax.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@id
Specifies an identifier for the current element. This ID is the target for references by @href and @conref attributes and for external applications that refer to DITA or LwDITA content. This attribute is defined with the XML data type NMTOKEN, except where noted for specific elements within the language reference.

See id attribute for more details.

@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a role that the element is playing. The role must be consistent with the basic semantic and expectations for the element. In particular, the @outputclass attribute can be used for styling during output processing; HTML output will typically preserve @outputclass for CSS processing.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@status
Specifies the modification status of the element. The following values are valid: new, changed, deleted, unchanged, and -dita-use-conref-target.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample contains three enumeration definitions:

<subjectScheme>
    
    <!-- DEFINE SETS OF CONTROLLED VALUES -->

    <!-- 1. Values for @audience on <draft-comment> -->
    <subjectdef keys="values-audience-draft-comment">
        <subjectdef keys="spec-editors"/>
        <subjectdef keys="tc-reviewers"/>
    </subjectdef>
    
    <!-- 2. Values for @otherprops -->
    <subjectdef keys="values-otherprops">
        <subjectdef keys="examples"/>
    </subjectdef>
    
    <!-- BINDS SETS OF CONTROLLED VALUES -->

    <!-- 1. Binding for @audience on <draft-comment> -->
    <enumerationdef>
        <elementdef name="draft-comment"/>
        <attributedef name="audience"/>
        <subjectdef keyref="values-audience-draft-comment"/>
        <defaultSubject keyref="spec-editors"/>
    </enumerationdef>
    
    <!-- 2. Binding for @otherprops -->
    <enumerationdef>
        <attributedef name="otherprops"/>
        <subjectdef keyref="values-otherprops"/>
    </enumerationdef>

    <!-- 3. Binding for @props -->
    <enumerationdef>
        <attributedef name="props"/>
        <subjectdef/>
    </enumerationdef>

</subjectScheme>
  1. The permissible values for the @audience attribute on the <draft-comment> element are restricted to the subject values-audience-draft-comment. This means that the only allowed values are spec-editors and tc-reviewers. If no value for @audience is specified for a <draft-comment> element in the DITA source, it is assumed to be set to spec-editors.
  2. The permissible values for @otherprops are restricted to the subject values-otherprops. This means that the only valid value for @otherprops is examples.
  3. The enumeration for the @props attribute contains a <subjectdef> element that does not reference a subject. That means that no values are valid for the @props attribute.

<schemeref>

A scheme reference is the mechanism for referencing a subject scheme map.

Specialization hierarchy

The <schemeref> element is specialized from <topicref>. It is defined in the subject scheme module.

Content model

<topicmeta> ?, <data> **

Contained by

<subjectScheme>

In order
  1. Optional <topicmeta>
  2. Zero or more Zero or more <data>

Contained by

Inheritance

- map/topicref subjectScheme/schemeref

The <schemeref> element is specialized from <topicref> . It is defined in the subjectScheme module.

Attributes

The following attributes are available on this element: link-relationship attributes, universal attributes, @impose-role, @keyref, and @keys.

For this element, the following considerations apply:
  • The @format attribute has a default value of ditamap.
  • The @impose-role attribute has a fixed value of keeptarget.
  • The @type attribute has a default value of scheme.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
The @format attribute has a default value of ditamap.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@impose-role
Specifies whether this element will impose its role on elements in a referenced map. The attribute is ignored if the target of the reference is not a map or branch of a map. The following values are valid:
keeptarget
The role of the current reference is not imposed on the target of the reference. This is the default for the unspecialized <topicref> element and for many convenience elements such as <keydef>.
impose
The role of the current reference is imposed on the target of the reference. For example, if a specialized topic reference <chapter> uses this value and references a map, a topic reference that resolves in place of the <chapter> will be treated as if it were a chapter.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The href attribute for detailed information on supported values and processing implications.

The @impose-role attribute has a fixed value of keeptarget.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@keys
Specifies one or more names for a resource. See Setting key names with the keys attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
The @type attribute has a default value of scheme.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See subjectScheme.

<subjectdef>

The <subjectdef> element defines a subject. A subject can be used to define a controlled value or a taxonomic classification.

Usage information

The <subjectdef> element can use a <navtitle> element to supply a label for the subject. The @href attribute on <subjectdef> can be used to reference a topic that provides more information about a subject and how authors should use it when classifying content or specifying a value for an attribute.

Specialization hierarchy

The <subjectdef> element is specialized from <topicref>. It is defined in the subject scheme module.

Content model

<topicmeta> ?, ( <data> | <subjectdef> | <subjectHead> | <topicref> )*

Contained by

<enumerationdef> , <subjectHead> , <subjectScheme> , <subjectdef>

In order
  1. Optional <topicmeta>
  2. Zero or more of the following

Contained by

Inheritance

- map/topicref subjectScheme/subjectdef

The <subjectdef> element is specialized from <topicref> . It is defined in the subjectScheme module.

Attributes

The following attributes are available on this element: link-relationship attributes, universal attributes, @collection-type, @impose-role, @keyref, @keys, @linking, @processing-role, and @toc.

For this element, the @impose-role attribute has a fixed value of keeptarget.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@impose-role
Specifies whether this element will impose its role on elements in a referenced map. The attribute is ignored if the target of the reference is not a map or branch of a map. The following values are valid:
keeptarget
The role of the current reference is not imposed on the target of the reference. This is the default for the unspecialized <topicref> element and for many convenience elements such as <keydef>.
impose
The role of the current reference is imposed on the target of the reference. For example, if a specialized topic reference <chapter> uses this value and references a map, a topic reference that resolves in place of the <chapter> will be treated as if it were a chapter.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The href attribute for detailed information on supported values and processing implications.

For this element, the @impose-role attribute has a fixed value of keeptarget.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@keys
Specifies one or more names for a resource. See Setting key names with the keys attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how <subjectdef> elements can be used.

Example 58. Example of defining a set of controlled values

The following code sample shows how <subjectdef> elements can be used to define a set of controlled values:

<subjectdef keys="values-product">
    <subjectdef keys="free"/>
    <subjectdef keys="premium"/>
</subjectdef>

When this set of controlled values is bound to an attribute, the only valid values for the attribute are free and premium.

Example 59. Example of defining a simple taxonomy

The following code sample shows how <subjectdef> elements can be used to define a simple taxonomy of recreational hobbies:

<subjectdef keys="hobbies">
    <subjectdef keys="fiber-arts">
        <subjectdef keys="knitting"/>
        <subjectdef keys="quilting"/>
        <subjectdef keys="sewing"/>
    </subjectdef>
    <subjectdef keys="woodworking">
        <subjectdef keys="scroll-sawing"/>
        <subjectdef keys="whittling"/>
        <subjectdef keys="wood-turning"/>
    </subjectdef>
</subjectdef>

The taxonomy might be used to classify DITA topics or maps.

<subjectHead>

The <subjectHead> element provides a heading for a group of subjects, for use if the subject scheme is rendered and displayed.

Usage information

The heading provided by the <subjectHead> element might be displayed when a subject scheme is rendered to let users select subjects as part of a faceted browsing experience.

The <subjectHead> element does not reference a resource. It also cannot specify either the @keys or @keyref attribute, so it does not define any controlled values.

Specialization hierarchy

The <subjectHead> element is specialized from <topicref>. It is defined in the subject scheme module.

Content model

<subjectHeadMeta> ?, ( <data> | <subjectdef> | <subjectHead> | <topicref> )*

Contained by

<subjectHead> , <subjectScheme> , <subjectdef>

In order
  1. Optional <subjectHeadMeta>
  2. Zero or more of the following

Contained by

Inheritance

- map/topicref subjectScheme/subjectHead

The <subjectHead> element is specialized from <topicref> . It is defined in the subjectScheme module.

Attributes

The following attributes are available on this element: universal attributes, @collection-type, @linking, @processing-role, and @toc,.

For this element, the following considerations apply:
  • The @collection-type attribute has an expected processing default value of unordered, although this value is not defaulted in the grammar files. This element limits the available values for @collection-type to unordered, sequence, and -dita-use-conref-target.
  • The @linking attribute has a default value of normal, and no other values are valid.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
The @collection-type attribute has an expected processing default value of unordered, although this value is not defaulted in the grammar files. This element limits the available values for @collection-type to unordered, sequence, and -dita-use-conref-target.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
The @linking attribute has a default value of normal, and no other values are valid.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In the following code sample, the <subjectHead> elements define two groupings of subjects and associate labels.

<subjectScheme toc="yes" search="no">
  <subjectdef keys="hobbies">
    <subjectdef keys="fiber-arts">
      <subjectHead>
        <subjectHeadMeta>
          <navtitle>Fiber arts</navtitle>
        </subjectHeadMeta>
        <subjectdef keys="knitting" href="knitting.dita"/>
        <subjectdef keys="quilting" href="quilting.dita"/>
        <subjectdef keys="sewing" href="sewing.dita/>
      </subjectHead>
    </subjectdef>
    <subjectdef keys="woodworking">
      <subjectHead>
        <subjectHeadMeta>
          <navtitle>Woodworking</navtitle>
        </subjectHeadMeta>
        <subjectdef keys="scroll-sawing" href="scroll-sawing.dita"/>
        <subjectdef keys="whittling" href="whittling.dita"/>
        <subjectdef keys="wood-turning" href="woodturning.dita"/>
      </subjectHead>
    </subjectdef>
  </subjectdef>
</subjectScheme>

<subjectHeadMeta>

The <subjectHeadMeta> element enables a navigation title and short description to be associated with a subject heading, for use if the subject scheme is rendered and displayed.

Specialization hierarchy

The <subjectHeadMeta> element is specialized from <topicmeta>. It is defined in the subject scheme module.

Content model

( <titlealt> | <navtitle> | <searchtitle> | <linktitle> | <subtitle> | <titlehint> )*, <shortdesc> ?

Contained by

<subjectHead>

In order
  1. Zero or more of the following
  2. Optional <shortdesc>

Contained by

Inheritance

- map/topicmeta subjectScheme/subjectHeadMeta

The <subjectHeadMeta> element is specialized from <topicmeta> . It is defined in the subjectScheme module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <subjectHead>.

<subjectScheme>

The <subjectScheme> element defines controlled values and taxonomic subjects.

Specialization hierarchy

The <subjectScheme> element is specialized from <map>. It is defined in the subject scheme module.

Content model

<title> ?, <topicmeta> ?, ( <data> | <enumerationdef> | <navref> | <reltable> | <schemeref> | <subjectdef> | <subjectHead> | <topicref> )*

Not contained by any element.

In order
  1. Optional <title>
  2. Optional <topicmeta>
  3. Zero or more of the following

Not contained by any element.

Inheritance

- map/map subjectScheme/subjectScheme

The <subjectScheme> element is specialized from <map> . It is defined in the subjectScheme module.

Attributes

The following attributes are available on this element: architectural attributes, common map attributes, universal attributes, @format, @scope, and @type.

For this element, the following considerations apply:
  • The @processing-role attribute has a default value of resource-only.
  • The @toc attribute has a default value of no.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@DITAArchVersion (architectural attributes)
Specifies the version of the DITA architecture that is in use. This attribute is in the namespace http://dita.​oasis-open.​org/​architecture/​2005/. This attribute is specified in the topic and map modules, and it uses a default value of the current version of DITA. The current default is 2.0.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

The @processing-role attribute has a default value of resource-only.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@specializations (architectural attributes)
Specifies the attribute-domain specializations that are included in the document-type shell. This attribute is set as a default within the document-type shell. The value varies depending on what domains are integrated into the document-type shell. For example, a grammar file that includes the specialized attributes @audience, @deliveryTarget, and @newBaseAtt would set the value to @props/audience @props/deliveryTarget @base/newBaseAtt.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
The @toc attribute has a default value of no.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a subject scheme map:

<subjectScheme>
  <!-- Pull in a scheme that defines values for @deliveryTarget -->
  <schemeref href="deliveryTarget.ditamap"/>
  <!-- Define values for Windows and Linux -->
  <subjectdef keys="operating-systems">
    <subjectdef keys="windows">
      <subjectdef keys="windows-10"/>
      <subjectdef keys="windows-11"/>
    </subjectdef>
    <subjectdef keys="linux">
      <subjectdef keys="redhat"/>
      <subjectdef keys="suse"/>
    </subjectdef>
  </subjectdef>
  <!-- Define application values -->
  <subjectdef keys="applications">
    <subjectdef keys="apache-server" href="subject/apache.dita"/>
    <subjectdef keys="my-sql"      href="subject/sql.dita"/>
  </subjectdef>

  <!-- Define an enumeration of the platform attribute. This makes the
       following values valuid for platform: windows, windows-10, windows-11,
       linux, redhat, and suse. -->
  <enumerationdef>
    <attributedef name="platform"/>
    <subjectdef keyref="operating-systems"/>
  </enumerationdef>
  <!-- Define an enumeration of the otherprops attribute, equal to
       each value in the application subjects.
       This makes the following values valid for the otherprops attribute:
       apache-server, my-sql -->
  <enumerationdef>
    <attributedef name="otherprops"/>
    <subjectdef keyref="applications"/>
  </enumerationdef>
</subjectScheme>

Metadata elements

The prolog elements represent metadata that is associated with a document. Most of these elements are valid in both topics and maps.

Descriptive metadata

The descriptive metadata elements are children of the <metadata> element. They contain information that describes the content of the topic or map.

<audience>

An audience is the group of readers for whom a piece of content is intended.

Content model

EMPTY

Contained by

<metadata>

Empty

Contained by

Inheritance

- topic/audience

The <audience> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@name
Specifies a name for the audience.
@type
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how the <audience> element can specify that a topic is intended for experienced programmers:

<prolog>
    <metadata>
        <audience type="programmer" experiencelevel="expert"/>
    </metadata>
</prolog>

<author>

An author is the entity that created the content, such as a person, organization, or application.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<prolog>

Zero or more of the following

Contained by

Inheritance

- topic/author

The <author> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows that two people contributed to the topic:

<prolog>
    <author type="creator">Jane</author>
    <author type="contributor">John</author>
</prolog>

Jane is specified as a creator of the topic, and John is specified as a contributor to the topic.

<category>

A category is a group of things that have shared characteristics.

Usage information

A category can be used to classify content for navigation or retrieval. Such classifications are likely to come from an enumerated or hierarchical set. A processor might sort topics based on the associated categories and create a type of generated navigation.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<metadata>

Zero or more of the following

Contained by

Inheritance

- topic/category

The <category> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows that a topic is associated with three categories:

<prolog>
  <metadata>
   <category>History</category>
   <category>Non-fiction</category>
   <category>Editors' choice</category>
  </metadata>
</prolog>

<keywords>

Key words are terms that apply to the topic or map.

Usage information

The content of the <keywords> element can be used to optimize the rendered output:

  • Processors might add metadata to the output format to facilitate search engine optimization.
  • Processors might use the content of <indexterm> elements to generate an index for a document.

While the <keyword> element can be used inline, the <keywords> element is not an inline element. The <keywords> element only appears in the <topicmeta> or <prolog>, and it is used to specify keywords that apply to the topic.

Processing expectations

All <keyword> and <indexterm> elements contained in the <keywords> element are considered part of the topic or map metadata. How the content of these elements is processed depends on the output medium.

Content model

( <indexterm> | <keyword> )*

Contained by

<metadata>

Zero or more of the following

Contained by

Inheritance

- topic/keywords

The <keywords> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how several key words can be associated with a topic that is related to installing software:

<prolog>
    <metadata>
        <keywords>
            <keyword>installing</keyword>
            <keyword>prerequisites</keyword>
            <keyword>wizards</keyword>
        </keywords>
    </metadata>
</prolog>

<othermeta>

Other metadata is metadata that specifies properties by using name and content pairs.

Usage information

The <othermeta> element enables implementations to specify custom metadata without specializing. <othermeta> element can also be used as a specialization base.

Content model

EMPTY

Contained by

<metadata>

Empty

Contained by

Inheritance

- topic/othermeta

The <othermeta> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@name (REQUIRED)
Specifies the name of the metadata property.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows that the metadata ThreadWidthSystem has a value of metric:

<prolog>
    <metadata>
        <othermeta name="ThreadWidthSystem" content="metric"/>
    </metadata>
</prolog>

<prodinfo>

Product information is detailed information about a product, such as the product name, version number, brand name, associated components, and more.

Content model

<prodname> , <vrmlist> ?, ( <brand> | <component> | <featnum> | <platform> | <prognum> | <series> )*

Contained by

<metadata>

In order
  1. <prodname>
  2. Optional <vrmlist>
  3. Zero or more of the following

Contained by

Inheritance

- topic/prodinfo

The <prodinfo> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <prodinfo> element can be used.

Example 60. Example of product information for an item of cookware

The following code sample shows the <prodinfo> element can contain several elements that specify metadata about an item of cookware:

<prolog>
  <metadata>
    <prodinfo>
      <prodname>12'' Stainless Steel Skillet</prodname>
      <brand>Chef's Gourmet Kitchenware</brand>
      <prognum>4545455-AD</prognum>
      <platform>Electric</platform>
      <platform>Gas</platform>
      <platform>Induction</platform>
      <series>Stainless Cookware</series>
    </prodinfo>
  </metadata>
</prolog>
Example 61. Example of product information for a software application

The following code sample shows that a topic is about the product Transcription Assistant. The product is at version number 1.3.1, operates on the Linux platform, and has the program number SN-12345T.

<prolog>
  <metadata>
    <prodinfo>
      <prodname>Transcription Assistant</prodname>
      <vrmlist>
        <vrm version="1" release="3" modification="1"/>
      </vrmlist>
      <featnum>SN-12345T</featnum>
      <component>Voice Activation</component>
      <platform>Linux</platform>
      <platform>Windows</platform>
    </prodinfo>
  </metadata>
</prolog>

<publisher>

A publisher is an entity (person, company, or organization) who makes information, literature, music, software, and other content available to a reader.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<prolog>

Zero or more of the following

Contained by

Inheritance

- topic/publisher

The <publisher> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows that the content is published by OASIS Open Printing, Inc:

<prolog>
    <author>Ivan</author>
    <publisher>OASIS Open Printing, Inc.</publisher>
</prolog>

<prodname>

A product name is the name that a business, company, or enterprise chooses to give a product.
Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<prodinfo>

Zero or more of the following

Contained by

Inheritance

- topic/prodname

The <prodname> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <prodinfo>.

<prognum>

A program number is an order number or a product tracking code.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<prodinfo>

Zero or more of the following

Contained by

Inheritance

- topic/prognum

The <prognum> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <prodinfo>.

Lifecycle management metadata

The lifecycle-management metadata elements are children of the <prolog> element. The contain information about the product lifecyle.

<copyrholder>

A copyright holder is the entity that holds the legal rights to a work that has been assigned a copyright.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<copyright>

Zero or more of the following

Contained by

Inheritance

- topic/copyrholder

The <copyrholder> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <copyright>.

<copyryear>

A copyright year is the year in which an author first published a work or submitted it to a copyright-granting agency.

Content model

EMPTY

Contained by

<copyright>

Empty

Contained by

Inheritance

- topic/copyryear

The <copyryear> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attribute defined below.

@year
Specifies the year in YYYY format

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <copyright>.

<created>

The creation date is the date that a document was created.

Content model

EMPTY

Contained by

<critdates>

Empty

Contained by

Inheritance

- topic/created

The <created> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: date attributes, universal attributes, and the attribute defined below.

@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@expiry (date attributes)
Specifies the date when the information should be retired or refreshed. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@golive (date attributes)
Specifies the publication or general availability (GA) date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <critdates>.

<critdates>

Critical dates are important dates in the document life cycle, such as creation and revision dates.

Content model

<created> ?, <revised> *

Contained by

<prolog>

In order
  1. Optional <created>
  2. Zero or more <revised>

Contained by

Inheritance

- topic/critdates

The <critdates> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows that the topic was created on 12 June 2020. It was revised on 03 March 2021, and it will expire on 02 March 2024.

<prolog>
    <critdates>
        <created date="2020-06-12"/>
        <revised modified="2021-03-03" golive="2020-02-03" expiry="2024-03-02"/>
    </critdates>
</prolog>

<metadata>

Metadata is data about data.

Usage information

Elements inside of the <metadata> element provide information about the content and subject of an information resource.

When used in topics, metadata elements that are outside of the <metadata> element generally provide lifecycle information for the content unit, such as the author or copyright.

When used in maps, several metadata elements are allowed both inside and outside of the <metadata> container element. This is done to provide parity with topic prologs.

Content model

<audience> *, <category> *, <keywords> *, <prodinfo> *, <othermeta> *, ( <data> | <sort-as> | <foreign> )*

Contained by

<prolog>

In order
  1. Zero or more <audience>
  2. Zero or more <category>
  3. Zero or more <keywords>
  4. Zero or more <prodinfo>
  5. Zero or more <othermeta>
  6. Zero or more of the following

Contained by

Inheritance

- topic/metadata

The <metadata> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how metadata can be provided in a topic about jet packs:

<prolog>
    <metadata>
        <audience type="user" job="flying" experiencelevel="advanced"/>
        <keywords>
            <keyword>jet pack</keyword>
            <keyword>danger</keyword>
            <keyword>liability</keyword>
        </keywords>
    </metadata>
</prolog>

<permissions>

Permissions are the level of entitlement that are needed to access content.

Content model

EMPTY

Contained by

<prolog>

Empty

Contained by

Inheritance

- topic/permissions

The <permissions> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attribute defined below.

@view
Specifies the classifications of viewers that are allowed to view the document

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows that the topic is only intended for an internal-user audience:

<prolog>
  <permissions view="internal-users"/>
</prolog>

<resourceid>

A resource ID is an identifier that is designed for applications that need to use their own identifier scheme, such as context-sensitive help systems and databases.

Usage information

The @appid and @appname attributes work in combination to specify a specific ID for an application. Multiple @appid values can be associated with a single @appname value, and multiple @appname values can be associated with a single @appid value.Accordingly, each combination of values for the @appid and @appname attributes need to be unique within the context of the main map.

When the @appid-role attribute is set to deliverable-anchor, the value that it specifies contributes to deliverable anchors for a topic. According, certain limitations apply to the value of the @appid attribute:

  • It specifies only a single URI component.
  • It is limited to values that can contribute to the following URI components:
    • The last path component of a URI path
    • A fragment identifier
    • A query parameter
  • It should not specify components of URIs that are specific to a particular deliverable, such as a file extension.

Processing expectations

By design, the <resourceid> element will not apply to all processors in all situations. Processors can examine the @appname and @appid-role attributes to determine whether a given <resourceid> element is relevant to a specific deliverable; if @appname is not present, processors can assume that the element applies.

When @appid-role is set to deliverable-anchor, and the <resourceid> applies to a deliverable, processors SHOULD use the @appid value when constructing a URI for the delivered resource. Effective @appid values for this reflect the application of any prefix or suffix values from dvrKeyscopePrefix and dvrResourceSuffix. Actual delivery anchors depend on the rendered format; for example, the anchor can be the base part of an HTML file name, a PDF anchor name, or a URI fragment identifier. While anchors values will vary by deliverable, the resulting URI should reflect the specified anchor as much as possible.

When @appid-role is set to context-sensitive-help or another value, processors can optionally use the @appid value IDs to construct deliverable anchors. Deliverable components MAY have any number of anchors when the deliverable format allows.

Processors can use other properties of the referenced resource, or properties of the reference itself, when constructing full deliverable anchors. For example, key scope names, key names, or source file names can all be used with the resource ID when constructing unique anchor values.

Content model

( <data> | <sort-as> )**

Contained by

<prolog>

Zero or more Zero or more of the following

Contained by

Inheritance

- topic/resourceid

The <resourceid> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@appname
Specifies a name for the external application.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <resourceid> element can be used.

Example 62. Example: Using a <resourceid> element in a map to generate hooks for online help

In the following code sample, user-assistance context hooks are applied to three topics that are referenced from a DITA map. The second topic has two hooks for the same topic.

<map>
 <title>Widget Help</title>
 <topicref href="file_ops.dita">
   <topicref href="saving.dita">
     <topicmeta>
     <resourceid appname="ua" appid="1234" ux-context-string="idh_filesave"
     ux-source-priority="topic-only"/>
     </topicmeta>
   </topicref>
   <topicref href="deleting.dita">
     <topicmeta>
      <resourceid appname="ua" 
           appid="2345" ux-context-string="idh_filedelete" />
      <resourceid appname="ua" 
           appid="6789" ux-context-string="idh_filekill" />
     </topicmeta>
   </topicref>
   <topicref href="editing.dita">
     <topicmeta>
       <resourceid appname="ua" 
            appid="5432" ux-context-string="idh_fileedit" ux-windowref="csh"  />
     </topicmeta>
   </topicref>
</topicref>
</map>
Example 63. Example: Using a <resourceid> element in a topic to generate hooks for online help

In the following code sample, a user-assistance context hook is defined in the prolog of a task topic. The context hook is made up of a context ID (value for @appid attribute) and a context string (value for @ux-context-string attribute). A user-assistance window profile is also referenced for this topic. 

<task id="fedt">
 <title>Editing a File</title>
 <prolog>
   <resourceid appname="ua" 
         appid="5432" ux-context-string="idh_fileedit" ux-windowref="csh" />
 </prolog>
 <taskbody>
  <context>After you have created a new file, you can edit it.</context> 
  <steps>
   <step><cmd>Open...</cmd></step>
   <step><cmd>Edit...</cmd></step>
   <step><cmd>Save...</cmd></step>
  </steps>
 </taskbody>
</task>
Example 64. Example: Using a <resourceid> element to XXX

In the following code sample, anchor components are defined for two different references to the same topic. Each use of the topic represents the documentation for a different model of the same base device.

<map>

  <!-- ... -->
  <keydef keys="topic-0014" href="replacing-widgetA.dita"/>
  <!-- ... -->

  <topicref keyscope="model-01">
    <!-- ... -->
    <topicref keys="replace-widgetA" keyref="topic-0014">
      <topicmeta>
        <resourceid appid="replace_widgetA_model_01" appid-role="deliverable-anchor"/>
      </topicmeta>
    </topicref>
    <!-- ... -->  
  </topicref>
  <topicref keyscope="model-02">
    <!-- ... -->
    <topicref keys="replace-widgetA" keyref="topic-0014">
      <topicmeta>
        <resourceid appid="replace_widgetA_model_02" appid-role="deliverable-anchor"/>
      </topicmeta>
    </topicref>
    <!-- ... -->
  </topicref>
  <!-- ... -->
</map>

The replacing-widgetA.dita topic is published twice, once in each scope. When the map is published, the following occurs:

  • An HTML deliverable might use the specified anchors to construct base file names for the resulting HTML. In this case, the copy in the first scope would use the name replace_widgetA_model_01.html, while the copy in the second scope uses the name replace_widgetA_model_02.
  • A PDF deliverable might simply add the application IDs as anchors for each instance of the topic, so that replace_widgetA_model_01 and replace_widgetA_model_02 would be available as anchors within the PDF.

<revised>

Revision information is used to maintain tracking dates that are important in a development cycle, such as the date of the last modification, the original availability date, and the expiration date.

Content model

EMPTY

Contained by

<critdates>

Empty

Contained by

Inheritance

- topic/revised

The <revised> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: date attributes, universal attributes, and the attribute defined below.

@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@expiry (date attributes)
Specifies the date when the information should be retired or refreshed. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@golive (date attributes)
Specifies the publication or general availability (GA) date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <critdates>.

<source>

A source is a resource from which the present topic is derived, either completely or in part.

Usage information

The <source> element contains a description of the resource. Alternatively, the @href or @keyref attributes can be used to reference a description of the resource.

Processing expectations

It is undefined what it means when the <source> element has both content and an attribute-based reference to another resource. It is up to the implementation to determine the processing for this situation.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> )*

Contained by

<prolog>

Zero or more of the following

Contained by

Inheritance

- topic/source

The <source> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: link-relationship attributes, universal attributes, and @keyref.

For this element, the @href attribute provides a reference to a resource from which the topic is derived.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
For this element, the @href attribute provides a reference to a resource from which the topic is derived.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows that the content is based on information from the XML Exchange Table Model Document Type Definition:

<prolog>
    <source>XML Exchange Table Model Document Type Definition</source>
</prolog>

Product information metadata

The product-information metadata elements are children of the <prodinfo> element. They contain information that provides additional details about the product.

<brand>

A brand is a name, term, design, or any other feature that uniquely identifies a good or service and distinguishes it from that of other sellers.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<prodinfo>

Zero or more of the following

Contained by

Inheritance

- topic/brand

The <brand> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <prodinfo>.

<component>

A component is a part of a larger whole, such as a machine, software application, or vehicle.

Usage information

A product might be made up of many components, each of which is installable separately. Components might also be shared by several products so that the same component is available for installation with many products.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<prodinfo>

Zero or more of the following

Contained by

Inheritance

- topic/component

The <component> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <prodinfo>.

<featnum>

A feature number is the number that is associated with a product feature.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<prodinfo>

Zero or more of the following

Contained by

Inheritance

- topic/featnum

The <featnum> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <prodinfo>.

<platform>

A platform is a group of technologies that are used as a base upon which other applications, processes, or technologies are developed.
Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<prodinfo>

Zero or more of the following

Contained by

Inheritance

- topic/platform

The <platform> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <prodinfo>.

<series>

A series is a set of related products or programs.
Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<prodinfo>

Zero or more of the following

Contained by

Inheritance

- topic/series

The <series> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <prodinfo>.

<vrmlist>

A version metadata list is a grouping of one or more <vrm> elements that specify information about the version, release, and modification levels of a product.

Content model

<vrm> +

Contained by

<prodinfo>

One or more <vrm>

Contained by

Inheritance

- topic/vrmlist

The <vrmlist> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows the version numbers that are associated with Widge-o-matic product:

<prolog>
    <metadata>
        <prodinfo>
            <prodname>Widge-o-matic</prodname>
            <vrmlist>
                <vrm version="1" release="2" modification="0"/>
                <vrm version="1" release="2" modification="1"/>
            </vrmlist>
        </prodinfo>
    </metadata>
</prolog>

This indicates that the topic covers Version 1, release 2, modification levels 0 and 1 (often expressed as version 1.2.0 and 1.2.1).

<vrm>

Version metadata is metadata that is used to track the version, release, and modification numbers for a product

Content model

EMPTY

Contained by

<vrmlist>

Empty

Contained by

Inheritance

- topic/vrm

The <vrm> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@modification
Specifies the modification level of the current version and release
@release
Specifies the product release identifier
@version (REQUIRED)
Specifies the released version number of the product

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <vrmlist>.

Specialization elements

Several DITA elements exist either for architectural reasons or for support of specialized markup yet to be designed.

There is little need to use these elements unless your content can take advantage of the semantic distinction.

<data>

Data is a generic component that represents metadata within a topic or map. Complex metadata is represented by nested data structures.

Usage information

The primary purpose of the <data> element is as a specialization base. Because it can nest, it can be used to create complex metadata structures. It is available in both block and inline contexts, which allows the <data> element to specify properties for most element types.

A metadata property specified using a <data> element usually applies to the structure that contains the <data> element.

When located in <prolog> and <metadata> elements, the property applies to the topic as a whole. When located in the <topicmeta> element, the property applies to the referenced topic.

Important (non-normative):
By default, processors do not render the content of the <data> element. Use the <data> element only for properties; do not use it to embed text as part of the content flow.

Rendering expectations

By default, processors SHOULD treat a <data> element as unknown metadata. The contents of the <data> element SHOULD NOT be rendered.

Processors that recognize a particular <data> element MAY make use of it to trigger specialized rendering.

Content model

(Text | <audio> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <image> | <object> | <required-cleanup> | <title> | <video> )*

Contained by

<abstract> , <alt> , <author> , <b> , <body> , <bodydiv> , <brand> , <category> , <cite> , <component> , <consequence> , <coords> , <copyrholder> , <data> , <dd> , <ddhd> , <desc> , <div> , <dl> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <featnum> , <fig> , <figgroup> , <fn> , <i> , <include> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <messagepanel> , <metadata> , <navtitle> , <note> , <ol> , <overline> , <p> , <ph> , <platform> , <pre> , <prodname> , <prognum> , <prolog> , <publisher> , <q> , <resourceid> , <searchtitle> , <section> , <series> , <shortdesc> , <sl> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <ul> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/data

The <data> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@datatype (data-element attributes)
Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
Defines a unique name for the object.
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
Specifies a value associated with the current property or element.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format

Examples

This section is non-normative.

This section contains examples of how the <data> element can be used.

Example 65. Using the @name attribute on unspecialized <data> elements

The following code sample shows how the <data> element can be used to provide metadata. Rendering tools that recognize this metadata can automatically apply highlighting to the code.

<codeblock>
  <data name="codestyle" value="javascript"/>
  <!-- JavaScript code block -->
</codeblock>
Example 66. Nesting <data> elements for complex metadata

The following code sample shows how nested <data> elements can provide complex inventory metadata for a part that is described in the topic:

<topic id="sample">
  <title>How to purchase items from the warehouse</title>
  <prolog>
    <data name="inventory">
      <data name="aisle" value="4"/>
      <data name="bin" value="13"/>
      <data name="restock" value="weekly"/>
    </data>
  </prolog>
  <body>
    <!-- ... -->
  </body>
</topic>
Example 67. Specializing <data> for structured metadata

The following code sample contains specializations of the <data> element: <change-item>, <change-completed>, and <change-summary>. These specialized elements each provide a default for @name inside the grammar files, so that processors can work with the data without authors having to specify the attribute.

<topic id="data">
  <title><xmlelement>data</xmlelement></title>
  <prolog>
    <change-historylist>
      <change-item>
        <change-completed>2017-08-20</change-completed>
        <change-summary>Refactored topic to use new template</change-summary>
      </change-item>
      <change-item>
        <change-completed>2018-06-06</change-completed>
        <change-summary>Created new examples</change-summary>
      </change-item>
    </change-historylist>
  </prolog>
  <body>
    <!-- ... -->
  </body>
</topic>

<foreign>

Foreign content is non-DITA content, such as MathML, SVG, or Rich Text Format (RTF).

Usage information

Specializations of the <foreign> element are typically implemented as domains, but it is also possible to implement foreign vocabularies as structural specializations.

The <foreign> element can contain non-DITA content or a mix of DITA and non-DITA content.

If alternate content is wanted, use or specialize the <desc> element inside of the <foreign> specialization. Such alternate content needs to be valid wherever the <foreign> specialization is valid. This way, if a processor is not able to recognize or render the <foreign> content itself, it can use the alternate content from <desc>.

Processing expectations

Processors attempt to display <foreign> content unless otherwise instructed. If a processor cannot render the content, it MAY issue a warning.

The enabler of the foreign vocabulary must provide the processing and override the base processing for <foreign>.

  • If <foreign> contains more than one alternative content element, they should all be processed. In the case of <desc> they should be concatenated in a similar way to <section>, but with no title (analogous to <div> in HTML).
  • If no <desc>, <object>, or <image> element is found within an instance of the <foreign> element, the base processing can emit a warning about the absence of processable content.
  • The base processing for <object> might emit the content of <foreign> as a file at the location specified by the @data attribute of the <object> element. The <object> element should have a data attribute or a <foreign> sub-element but not both. In the event that an <object> element contains both a data attribute and an <foreign> sub-element the processing system should ignore one of them.

Content model

Any

Contained by

<abstract> , <alt> , <audio> , <author> , <b> , <body> , <bodydiv> , <brand> , <category> , <cite> , <component> , <consequence> , <coords> , <copyrholder> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <featnum> , <fig> , <figgroup> , <fn> , <i> , <include> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <metadata> , <navtitle> , <note> , <object> , <overline> , <p> , <ph> , <platform> , <pre> , <prodname> , <prognum> , <prolog> , <publisher> , <q> , <searchtitle> , <section> , <series> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <video> , <xref>

Any content

Contained by

Inheritance

- topic/foreign

The <foreign> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format

Example

This section is non-normative.

The following code sample shows a specialization of <foreign> that is used to hold SVG elements. For this to work, the specialization module that defines <svg> also needs to include the definitions for the SVG elements.

<p>... as in the formula 
  <svg>
    <svg:svg width="100%" height="100%" version="1.1"
xmlns="http://www.w3.org/2000/svg">

<ellipse cx="300" cy="150" rx="200" ry="80"
style="fill:rgb(200,100,50);
stroke:rgb(0,0,100);stroke-width:2"/>

    </svg:svg>    
  </svg>.
</p>

<no-topic-nesting>

The <no-topic-nesting> element is a placeholder in the DITA architecture.

Usage information

The <no-topic-nesting> element is not intended for use in DITA source files.

The <no-topic-nesting> element is designed for use only when configuring a document-type shell using DTD syntax. It enables the DITA practitioner to disallow topic nesting for the topic type. This element is not required for document-type shells created using RELAX NG, which uses the native RNG <empty> element to accomplish the same thing.

Content model

EMPTY

Not contained by any element.

Empty

Not contained by any element.

Inheritance

- topic/no-topic-nesting

The <no-topic-nesting> element is a base element type. It is defined in the topic module.

Attributes

The following attribute is available on this element: @class.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@class (not for use by authors)
This attribute is not for use by authors. If an editor displays @class attribute values, do not edit them. Specifies a default value that defines the specialization ancestry of the element. Its predefined values allow DITA tools to work correctly with specialized elements. In a generalized DITA document the @class attribute value in the generalized instance might differ from the default value for the @class attribute for the element as given in the DTD or schema. See The class attribute rules and syntax for more information. This attribute is specified on every element except for the <dita> container element. It is always specified with a default value, which varies for each element.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format

Example

This section is non-normative.

In the DTD document-type shells that are distributed by OASIS for the base topic, the %topic-info-types; entity is set to topic. This means that <topic> elements can nest other <topic> elements. The following code sample shows how the %topic-info-types; entity can be redefined using no-topic-nesting in order to disallow nested topics:
<!ENTITY % topic-info-types
              "no-topic-nesting"
>

Now, topics that use that document-type shell can no longer nest other topics. DTD grammar rules require that some element be specified in this entity, so <no-topic-nesting> is used as a placeholder.

Domain elements

A domain is a grouping of related DITA elements that can be integrated into document-type shells. The base edition of DITA includes a variety of domains for use in topics and maps.

Alternative-titles domain elements

The alternative title elements are designed to provide alternative titles for resources. The elements in the alternative-titles domain are specialized from the <titlealt> element.

<linktitle>

A link title is an alternative title for a resource. It is designed for use when a hyperlink or a cross-reference to a resource is generated based on relationships described in a DITA map.

Usage information

The <linktitle> element is a convenience element. It is equivalent to a <titlealt> element with @title-role set to linking.

Features of DITA maps, such as relationship tables and hierarchies created by nesting <topicref> elements, generate the following kinds of links:

  • Links from a topic to its child topics in the map hierarchy
  • Links from a topic to its parent topic in the map hierarchy
  • Links between sibling topics when the @collection-type attribute of the parent <topicref> element is set to sequence or family

Processors might also use a link title for custom linking scenarios.

Processing expectations

Processing expectations are dictated by the rules for the <titlealt> element.

Specialization hierarchy

The <linktitle> element is specialized from <titlealt>. It is defined in the alternative-titles domain module.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <draft-comment> | <required-cleanup> )*

Contained by

<prolog>

Zero or more of the following

Contained by

Inheritance

+ topic/titlealt alternativeTitles-d/linktitle

The <linktitle> element is specialized from <titlealt> . It is defined in the alternativeTitles-domain module.

Attributes

The following attributes are available on this element: universal attributes and @title-role.

For this element, @title-role has a default value of linking.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@title-role (REQUIRED)
Specifies the role that the alternative title serves. Multiple roles are separated by white space. The following roles are defined in the specification: linking, navigation, search, subtitle, and hint.

Processors can define custom values for the @title-role attribute.

For this element, @title-role has a default value of linking.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <linktitle> element can be used.

Example 68. Link title within a map

The following code sample shows how a <linktitle> element can be used to provide text for a related link to a non-DITA resource:

<topicref href="SQLJ-example.html" format="html" scope="local">
  <topicmeta>
    <linktitle>Accessing relational data with SQLJ</linktitle>
  </topicmeta>
</topicref>
Example 69. Link title within a topic

The following code sample shows how a <linktitle> element can be used to provide text for generated links to a topic:

<topic id="topic">
  <title>Circuitry in the C-283 Drive Train</title>
  <prolog>
    <linktitle>Drive train circuitry</linktitle>
  </prolog>

Note that this link title might be overridden by a link title that is specified in a DITA map that references the topic.

<searchtitle>

A search title is an alternative title that is displayed by search tools.

Usage information

A search title is useful when the topic has a title that makes sense in the context of a single information set, but might be too general in a list of search results. For example, a topic title of Markup example makes sense as part of a guide about DITA, but when found among thousands of unrelated topics, a search title of DITA markup example is more useful.

The <searchtitle> element is a convenience element. It is equivalent to a <titlealt> element with @title-role set to search.

Processing expectations

Processing expectations are dictated by the rules for the <titlealt> element.

Specialization hierarchy

The <searchtitle> element is specialized from <titlealt>. It is defined in the alternative-titles domain module.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <draft-comment> | <required-cleanup> )*

Contained by

<prolog>

Zero or more of the following

Contained by

Inheritance

+ topic/titlealt alternativeTitles-d/searchtitle

The <searchtitle> element is specialized from <titlealt> . It is defined in the alternativeTitles-domain module.

Attributes

The following attributes are available on this element: universal attributes and @title-role.

For this element, @title-role has a default value of search.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@title-role (REQUIRED)
Specifies the role that the alternative title serves. Multiple roles are separated by white space. The following roles are defined in the specification: linking, navigation, search, subtitle, and hint.

Processors can define custom values for the @title-role attribute.

For this element, @title-role has a default value of search.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <searchtitle> element can be used.

Example 72. Search title used in a topic

In the following code sample, the title "Programming Example" is useful in a set of information about XSLT basics; however, the same title is not helpful among a set of search results from the entire Internet. In the latter case, a title of "Example of basic programming in XSLT" is more useful:

<topic id="programming-example">
  <title>Programming example</title>
  <prolog>
    <searchtitle>Example of basic programming in XSLT</searchtitle>
  </prolog>
  <body> 
    <!-- ... -->  
  </body>
</topic>
Example 73. Search title used in a map

When <searchtitle> is used in maps, the element provides a new search title for the topic when used in that specific context. For example, if the following code sample is from a map that includes information about programming in many languages, searches among that information set will be most useful when they return "Example of programming in XSLT":

<topicref href="programming-example.dita">
  <topicmeta>
    <navtitle>Programming example</navtitle>
    <searchtitle>Example of programming in XSLT</searchtitle>
  </topicmeta>
</topicref>

<subtitle>

A subtitle is an subordinate title for a resource. It is designed to augment the information about the resource in certain display contexts.

Usage information

The <subtitle> element is a convenience element. It is equivalent to a <titlealt> element with @title-role set to subtitle.

Processing expectations

Processing expectations are dictated by the rules for the <titlealt> element.

Specialization hierarchy

The <subtitle> element is specialized from <titlealt>. It is defined in the alternative-titles domain module.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <draft-comment> | <required-cleanup> )*

Contained by

<prolog>

Zero or more of the following

Contained by

Inheritance

+ topic/titlealt alternativeTitles-d/subtitle

The <subtitle> element is specialized from <titlealt> . It is defined in the alternativeTitles-domain module.

Attributes

The following attributes are available on this element: universal attributes and @title-role.

For this element, @title-role has a default value of subtitle.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@title-role (REQUIRED)
Specifies the role that the alternative title serves. Multiple roles are separated by white space. The following roles are defined in the specification: linking, navigation, search, subtitle, and hint.

Processors can define custom values for the @title-role attribute.

For this element, @title-role has a default value of subtitle.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <subtitle> element can be used.

Example 74. Subtitle used within a map

The following code sample shows how a map can specify a subtitle for the publication:

<map>
  <title>Frankenstein</title>
  <topicmeta>
    <subtitle>The Modern Prometheus</subtitle>
  </topicmeta>
</map>
Example 75. Subtitle used within a topic

The following code sample shows how a topic can specify a subtitle:

<topic id="topic">
  <title>Getting started</title>
  <prolog>
    <subtitle>An introduction to the Acme Inc. processing system</subtitle>
  </prolog>

<titlehint>

A title hint provides information to map authors about the title of the referenced resource. This is useful if the referenced resources are not available.

Usage information

The <titlehint> element is a convenience element. It is equivalent to a <titlealt> element with @title-role set to hint.

Processing expectations

Processing expectations are dictated by the rules for the <titlealt> element.

Specialization hierarchy

The <titlehint> element is specialized from <titlealt>. It is defined in the alternative-titles domain module.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <draft-comment> | <required-cleanup> )*

Contained by

<prolog>

Zero or more of the following

Contained by

Inheritance

+ topic/titlealt alternativeTitles-d/titlehint

The <titlehint> element is specialized from <titlealt> . It is defined in the alternativeTitles-domain module.

Attributes

The following attributes are available on this element: universal attributes and @title-role.

For this element, @title-role has a default value of hint.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@title-role (REQUIRED)
Specifies the role that the alternative title serves. Multiple roles are separated by white space. The following roles are defined in the specification: linking, navigation, search, subtitle, and hint.

Processors can define custom values for the @title-role attribute.

For this element, @title-role has a default value of hint.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how a <titlehint> element is used to show the title of a referenced topic to map authors. This might be especially helpful in the context of a CCMS with opaque URIs.

<topicref href="x-id://AOE82KJAW1B0">
  <topicmeta>
    <titlehint>Getting started</titlehint>
  </topicmeta>
</topicref>

DITAVAL-reference domain element

The DITAVAL reference domain is used to reference a DITAVAL file that contains conditions that apply only to a subset of a DITA map. It also can be used to replicate a subset of a DITA map for multiple audiences.

<ditavalref>

The <ditavalref> element references a DITAVAL document that specifies filter conditions to be used when processing a map or map branch.

Processing expectations

When a <ditavalref> element is included in a map, the conditions in the referenced DITAVAL document are used to filter the elements in the branch. The branch includes the parent element that contains the <ditavalref> element, any child elements, and all resources that are referenced by the parent element or its children. While there is no technical restriction that forces <ditavalref> to appear before peer topic references, placing them first is considered a best practice and all examples in the specification will use this convention.

In the simple case, a map can use <ditavalref> as follows:
<map>
  <topicref href="sampleBranch.dita" audience="admin">
    <topicmeta>
      <navtitle>Navigation title for branch</navtitle>
    </topicmeta>
    <ditavalref href="conditions.ditaval"/>
    <topicref href="insideBranch.dita" platform="win linux mac"/>
  </topicref>
  <!-- Other branches not affected by conditions.ditaval -->
</map>
The filtering conditions specified in the conditions.ditaval file apply to the following:
  • The <topicref> element that references sampleBranch.dita and all child elements: <topicmeta>, <navtitle>, and <topicref> elements
  • The sampleBranch.dita topic
  • The insideBranch.dita topic

When more than one <ditavalref> element is specified in the same branch at the same level, the effective result is one copy of the branch for each <ditavalref> element. If the example above contains a reference to otherConditions.ditaval as a peer to the existing <ditavalref> element, the rendered version of this map would reflect two copies of "Sample branch", each reflecting the conditions that are specified in the corresponding DITAVAL document. One copy is created using the conditions in conditions.ditaval, while the other copy uses the conditions from otherConditions.ditaval. Map authors can use specific elements from the DITAVAL reference domain to indicate how resources are renamed, or processors can recover from naming collisions by using an alternate naming scheme. See Limitations below for more information.

If DITAVAL conditions are specified at multiple levels within a single branch, "exclude" conditions that are specified at a higher level take precedence. In the following branch, assume alternate rules are specified for the condition audience="novice", with the value set to "exclude" in highLevel.ditaval and "include" in lowLevel.ditaval. In that case, the "exclude" condition specified in highLevel.ditaval takes precedence and so applies to the entire branch. This is true regardless of how the "exclude" condition is specified within highLevel.ditaval. That is, there might be a specific rule for audience="novice"; alternatively, the @audience attribute might be set to "exclude" by default, with no specific condition specified for the value audience="novice".
<topicref href="ancestor.dita">
  <ditavalref href="highLevel.ditaval"/>
  <topicref href="descendent.dita">
    <ditavalref href="lowLevel.ditaval"/>
    <!-- Other topicrefs -->
  </topicref>
</topicref>

If a <ditavalref> element is used that does not specify the @href attribute, the element is still processed but no additional filtering is applied. This can be used to create an unfiltered copy of a map branch alongside other filtered copies; other aspects of the <ditavalref> (such as any specified key scope or modified resource name) will still be applied to the branch.

Limitations

The following limitations apply when using the <ditavalref> element; these limitations cannot be enforced in a DTD or other XML grammar files.

When the use of the <ditavalref> element results in multiple copies of a branch, resource names within that branch can be controlled with sub-elements of the effective <ditavalref>. For situations where resource names are relevant, it is an error condition for multiple <ditavalref> elements to result in conflicting resource names for different content. For example, the following map fragment would result in two distinct copies of the c.dita topic with the same file name:
<topicref href="c.dita">
  <ditavalref href="one.ditaval"/>
  <ditavalref href="two.ditaval"/>
</topicref>
Processors MAY recover by using an alternate naming scheme for the conflicting copies.
Specialization hierarchy

The <ditavalref> element is specialized from <topicref>. It is defined in the DITAVAL-reference domain module.

Content model

<ditavalmeta> ?

Contained by

<keydef> , <map> , <mapresources> , <relcell> , <relcolspec> , <topicgroup> , <topichead> , <topicref>

Optional <ditavalmeta>

Contained by

Inheritance

+ map/topicref ditavalref-d/ditavalref

The <ditavalref> element is specialized from <topicref> . It is defined in the ditavalref-domain module.

Attributes

The following attributes are available on this element: universal attributes (except for @conkeyref, which is removed for all elements in this domain), @format, @href, @impose-role, and @scope.

For this element:
  • The @format attribute has a default value of ditaval.
  • The @impose-role attribute has a fixed value of keeptarget.
  • The @href attribute specivies a reference to a DITAVAL document. If the @href attribute is unspecified, this <ditavalref> will not result in any new filtering behavior, but other aspects of the element are still evaluated.
  • The @processing-role attribute has a default value of resource-only.

The following attributes are available on this element: universal attributes (except for @conkeyref which is removed for all elements in this domain) and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
The @format attribute has a default value of ditaval.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
The @href attribute specivies a reference to a DITAVAL document. If the @href attribute is unspecified, this <ditavalref> will not result in any new filtering behavior, but other aspects of the element are still evaluated.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@impose-role
Specifies whether this element will impose its role on elements in a referenced map. The attribute is ignored if the target of the reference is not a map or branch of a map. The following values are valid:
keeptarget
The role of the current reference is not imposed on the target of the reference. This is the default for the unspecialized <topicref> element and for many convenience elements such as <keydef>.
impose
The role of the current reference is imposed on the target of the reference. For example, if a specialized topic reference <chapter> uses this value and references a map, a topic reference that resolves in place of the <chapter> will be treated as if it were a chapter.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The href attribute for detailed information on supported values and processing implications.

The @impose-role attribute has a fixed value of keeptarget.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role
The @processing-role attribute has a default value of resource-only.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See Examples of branch filtering for several examples of the <ditavalref> element.

<ditavalmeta>

The <ditavalmeta> element defines metadata for use when processing a DITAVAL document for one branch of a map.

Usage information

Use the <ditavalmeta> element to specify the prefixes and suffixes that processors use to construct effective resource names, key scope names, and resource IDs within the map branch. The <ditavalmeta> element can also contain other information, such as navigation title, that might be useful for map architects but is not intended for rendering.

Specialization hierarchy

The <ditavalmeta> element is specialized from <topicmeta>. It is defined in the DITAVAL-reference domain module.

Content model

( <titlealt> | <navtitle> | <searchtitle> | <linktitle> | <subtitle> | <titlehint> )*, <dvrResourcePrefix> ?, <dvrResourceSuffix> ?, <dvrKeyscopePrefix> ?, <dvrKeyscopeSuffix> ?

Contained by

<ditavalref>

In order
  1. Zero or more of the following
  2. Optional <dvrResourcePrefix>
  3. Optional <dvrResourceSuffix>
  4. Optional <dvrKeyscopePrefix>
  5. Optional <dvrKeyscopeSuffix>

Contained by

Inheritance

+ map/topicmeta ditavalref-d/ditavalmeta

The <ditavalmeta> element is specialized from <topicmeta> . It is defined in the ditavalref-domain module.

Attributes

The following attributes are available on this element: universal attributes (except for @conkeyref, which is removed for all elements in this domain).

The following attributes are available on this element: universal attributes (except for @conkeyref which is removed for all elements in this domain) and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See Examples of branch filtering for several examples of the <ditavalref> element.

<dvrResourcePrefix>

The <dvrResourcePrefix> element specifies the prefix to use when constructing the effective file names or resource IDs of the resources that are referenced from within the map branch that is implied by the ancestor <ditavalref> element.

Processing expectations

For map branches that are implied by <ditavalref> elements, the value of the <dvrResourcePrefix> element contributes to the effective file names and resource IDs of resources that are referenced within the branch. The effective resource file name starts with the value of the <dvrResourcePrefix> element. If a topic reference includes <resourceid> with the @appid-role attribute set to deliverable-anchor, the effective @appid value for that <resourceid> value starts with the value of the <dvrResourcePrefix> element.

Some resources are not eligible for renaming, such as those marked with scope="external".

Specialization hierarchy

The <dvrResourcePrefix> element is specialized from <data>. It is defined in the DITAVAL-reference domain module.

Content model

(Text | <text> )*

Contained by

<ditavalmeta>

Zero or more of the following

Contained by

Inheritance

+ topic/data ditavalref-d/dvrResourcePrefix

The <dvrResourcePrefix> element is specialized from <data> . It is defined in the ditavalref-domain module.

Attributes

The following attributes are available on this element: universal attributes (except for @conkeyref, which is removed for all elements in this domain) and @name.

For this element, the @name attribute has a default value of dvrResourcPrefix.

The following attributes are available on this element: universal attributes (except for @conkeyref which is removed for all elements in this domain) and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
Defines a unique name for the object.
For this element, the @name attribute has a default value of dvrResourcPrefix.
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

Example 76. How <dvrResourcePrefix> affects resource file names
The following code sample shows a simple branch with a parent and child topic, where the branch uses a <ditavalref> element and <dvrResourcePrefix>.
<topicref href="branch-01.dita">
  <ditavalref href="condition-01.ditaval">
    <ditavalmeta>
      <dvrResourcePrefix>cond01-</dvrResourcePrefix>
    </ditavalmeta>
  </ditavalref>
  <topicref href="topics/subtopic-01.dita"/>
</topicref>
After the <ditavalref> is evaluated:
  • The effective file name of the resource subtopic-01.dita is cond01-subtopic-01.dita.
  • The effective file name of resource branch-01.dita is cond01-branch-01.dita.
Example 77. How <dvrResourcePrefix> interacts with <resourceid>
The following code sample shows the same branch with a parent and child topic, but in this case the child topic specifies a deliverable anchor with <resourceid>.
<topicref href="branch-01.dita">
  <ditavalref href="condition-01.ditaval">
    <ditavalmeta>
      <dvrResourcePrefix>cond01-</dvrResourcePrefix>
    </ditavalmeta>
  </ditavalref>
  <topicref href="topics/subtopic-01.dita">
    <topicmeta>
      <resourceid appid="ae35-unit-fault" appid-role="deliverable-anchor"/>
    </topicmeta>
  </topicref>
</topicref>
After the <ditavalref> is evaluated:
  • The effective file name of the resource subtopic-01.dita is cond01-subtopic-01.dita.
  • The effective file name of resource branch-01.dita is cond01-branch-01.dita.
  • The effective value of @appid on <resourceid> for the child topic is cond01-ae35-unit-fault.

<dvrResourceSuffix>

The <dvrResourceSuffix> element specifies the prefix to use when constructing the effective file names or resource IDs of the resources that are referenced from within the map branch that is implied by the ancestor <ditavalref> element.

Processing expectations

For map branches that are implied by <ditavalref> elements, the value of the <dvrResourceSuffix> element contributes to the effective file names and resource IDs of the resources that are referenced within the branch. The base part of the effective resource file name ends with the value of the <dvrResourceSuffix> element. The base part of the resource file name consists of the portion of the file name after any directory information, and before any period followed by the file extension. For example, in the original file name task/install.dita, the base portion of the file name is "install".

If a topic reference includes <resourceid> with the @appid-role attribute set to deliverable-anchor, the effective @appid value for that <resourceid> value ends with the value of the <dvrResourceSuffix> element.

Path information is not valid in <dvrResourceSuffix>.

Some resources are not eligible for renaming, such as those marked with scope="external".

Specialization hierarchy

The <dvrResourceSuffix> element is specialized from <data>. It is defined in the DITAVAL-reference domain module.

Content model

(Text | <text> )*

Contained by

<ditavalmeta>

Zero or more of the following

Contained by

Inheritance

+ topic/data ditavalref-d/dvrResourceSuffix

The <dvrResourceSuffix> element is specialized from <data> . It is defined in the ditavalref-domain module.

Attributes

The following attributes are available on this element: universal attributes (except for @conkeyref, which is removed for all elements in this domain) and @name.

For this element, the @name attribute has a default value of dvrResourcSuffix.

@name
The name of the metadata item. For this element the default value is "dvrResourceSuffix".

The following attributes are available on this element: universal attributes (except for @conkeyref which is removed for all elements in this domain) and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
Defines a unique name for the object.
For this element, the @name attribute has a default value of dvrResourcSuffix.
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

Example 78. How <dvrResourceSuffix> affects resource file names
The following code sample shows a simple branch with a parent and child topic, where the branch uses a <ditavalref> element and <dvrResourceSuffix>.
<topicref href="branch-01.dita">
  <ditavalref href="condition-01.ditaval">
    <ditavalmeta>
      <dvrResourceSuffix>-cond01</dvrResourceSuffix>
    </ditavalmeta>
  </ditavalref>
  <topicref href="topics/subtopic-01.dita"/>
</topicref>
After the <ditavalref> is evaluated:
  • The effective file name of the resource subtopic-01.dita is subtopic-01-cond01.dita.
  • The effective file name of resource branch-01.dita is branch-01-cond01.dita.
Example 79. How <dvrResourceSuffix> interacts with <resourceid>
The following code sample shows the same branch with a parent and child topic, but in this case the child topic specifies a deliverable anchor with <resourceid>.
<topicref href="branch-01.dita">
  <ditavalref href="condition-01.ditaval">
    <ditavalmeta>
      <dvrResourceSuffix>cond01-</dvrResourceSuffix>
    </ditavalmeta>
  </ditavalref>
  <topicref href="topics/subtopic-01.dita">
    <topicmeta>
      <resourceid appid="ae35-unit-fault" appid-role="deliverable-anchor"/>
    </topicmeta>
  </topicref>
</topicref>
After the <ditavalref> is evaluated:
  • The effective file name of the resource subtopic-01.dita is subtopic-01-cond01.dita.
  • The effective file name of resource branch-01.dita is branch-01-cond01.dita.
  • The effective value of @appid on <resourceid> for the child topic is ae35-unit-fault-cond01.

<dvrKeyscopePrefix>

The <dvrKeyscopePrefix> element specifies the prefix to use when constructing the effective key scope names for the map branch that is implied by the ancestor <ditavalref> element.

Processing expectations

For map branches that are implied by <ditavalref> elements, the value of the <dvrKeyscopePrefix> element contributes to the effective key scope names of the branch. The effective key scope names start with the value of the <dvrKeyscopePrefix> element. Note that if the branch as authored does not specify a @keyscope value, specifying <dvrKeyscopePrefix> (without also specifying <dvrKeyscopeSuffix>) results in the branch establishing a key scope whose name is the value of the <dvrKeyscopePrefix> element. The full key scope names will also reflect the value of a <dvrKeyscopeSuffix> element if one is specified, regardless of whether the branch as authored specifies a @keyscope value.

Specialization hierarchy

The <dvrKeyscopePrefix> element is specialized from <data>. It is defined in the DITAVAL-reference domain module.

Content model

(Text | <text> )*

Contained by

<ditavalmeta>

Zero or more of the following

Contained by

Inheritance

+ topic/data ditavalref-d/dvrKeyscopePrefix

The <dvrKeyscopePrefix> element is specialized from <data> . It is defined in the ditavalref-domain module.

Attributes

The following attributes are available on this element: universal attributes (except for @conkeyref, which is removed for all elements in this domain) and @name.

For this element, the @name attribute has a default value of dvrKeyscopePrefix.

The following attributes are available on this element: universal attributes (except for @conkeyref which is removed for all elements in this domain) and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
Defines a unique name for the object.
For this element, the @name attribute has a default value of dvrKeyscopePrefix.
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how <dvrKeyscopePrefix> supplements the existing key scope name of branch-01 to establish an effective key scope of cond01-branch-01:
<topicref keys="branch-01"
    href="branch-01.dita" 
    keyscope="branch-01"
  >
  <ditavalref href="condition-01.ditaval">
    <ditavalmeta>
      <dvrKeyscopePrefix>cond01-</dvrKeyscopePrefix>
    </ditavalmeta>
  </ditavalref>
  <topicref href="topics/subtopic-01.dita"/>
</topicref>

<dvrKeyscopeSuffix>

The <dvrKeyscopeSuffix> element specifies the suffix to use when constructing the effective key scope names for the map branch that is implied by the ancestor <ditavalref> element.

Processing expectations

For map branches that are implied by <ditavalref> elements, the value of the <dvrKeyscopeSuffix> element contributes to the effective key scope names of the branch. The effective key scope names end with the value of the <dvrKeyscopeSuffix> element. Note that if the branch as authored does not specify a @keyscope value, specifying <dvrKeyscopeSuffix> (without also specifying <dvrKeyscopePrefix>) results in the branch establishing a key scope whose name is the value of the <dvrKeyscopeSuffix> element. The full key scope names will also reflect the value of a <dvrKeyscopePrefix> element if one is specified, regardless of whether the branch as authored specifies a @keyscope value.

Specialization hierarchy

The <dvrKeyscopeSuffix> element is specialized from <data>. It is defined in the DITAVAL-reference domain module.

Content model

(Text | <text> )*

Contained by

<ditavalmeta>

Zero or more of the following

Contained by

Inheritance

+ topic/data ditavalref-d/dvrKeyscopeSuffix

The <dvrKeyscopeSuffix> element is specialized from <data> . It is defined in the ditavalref-domain module.

Attributes

The following attributes are available on this element: universal attributes (except for @conkeyref, which is removed for all elements in this domain) and @name.

For this element, the @name attribute has a default value of dvrKeyscopeSuffix.

The following attributes are available on this element: universal attributes (except for @conkeyref which is removed for all elements in this domain) and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
Defines a unique name for the object.
For this element, the @name attribute has a default value of dvrKeyscopeSuffix.
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how <dvrKeyscopeSuffix> supplements the existing key scope name of branch-01 to establish an effective key scope of branch-01-cond01:
<topicref keys="branch-01"
    href="branch-01.dita" 
    keyscope="branch-01"
  >
  <ditavalref href="condition-01.ditaval">
    <ditavalmeta>
      <dvrKeyscopeSuffix>-cond01</dvrKeyscopeSuffix>
    </ditavalmeta>
  </ditavalref>
  <topicref href="topics/subtopic-01.dita"/>
</topicref>

Emphasis domain elements

The emphasis elements are used to indicate text that has special meaning or importance, or text that needs to be distinguished from surrounding text.

<em>

Emphasis indicates special meaning or particular importance.

Rendering expectations

For Western languages, the content of the <em> element is typically rendered in an italic font.

Specialization hierarchy

The <em> element is specialized from <ph>. It is defined in the emphasis-domain module.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <alt> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

+ topic/ph emphasis-d/em

The <em> element is specialized from <ph> . It is defined in the emphasis-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how the <em> element can be used to emphasize a phrase in a paragraph:

<p>A good plan once adopted and put into execution <em>should not be 
abandoned</em> unless it becomes clear that it can not succeed.</p>

<strong>

Strong text is text that is of greater importance than the surrounding text.

Rendering expectations

The content of the <strong> element is typically rendered in a bold font.

Specialization hierarchy

The <strong> element is specialized from <ph>. It is defined in the emphasis-domain module.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <alt> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

+ topic/ph emphasis-d/strong

The <strong> element is specialized from <ph> . It is defined in the emphasis-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how the <strong> element can be used to highlight an important detail:

<p>Your doctor prescribed this medicine to treat an infection.
It is important that you <strong>take all of the medicine</strong> 
as described.</p>

Hazard-statement domain elements

The <hazardstatement> domain adds markup to support hazard statements. It is based on the regulations of ANSI Z535 and ISO 3864. The domain enables authors to provide all the information necessary for a hazard statement: a signal word, description of the hazard and its consequences, how to avoid the hazard, and one or more images.

<consequence>

A consequence is a result or effect of an action or condition. In the context of a hazard statement, it is the result of failing to avoid a hazard.

Specialization hierarchy

The <consequence> element is specialized from <div>. It is defined in the hazard-statement domain module.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <tm> | <hazardsymbol> )*

Contained by

<messagepanel>

Zero or more of the following

Contained by

Inheritance

+ topic/div hazard-d/consequence

The <consequence> element is specialized from <div> . It is defined in the hazard-domain module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows the markup for a hazard statement that warns about hot surfaces. The <consequence> element provides information about what might happen: "Contact might cause a burn."

<hazardstatement type="caution">
  <messagepanel>
    <typeofhazard>
      <hazardsymbol keyref="hazard-hotsurface"/>
      HOT SURFACES
    </typeofhazard>
    <consequence>Contact may cause a burn.</consequence>
    <howtoavoid>Wear gloves before servicing internal parts.</howtoavoid>
  </messagepanel> 
</hazardstatement>

<hazardstatement>

A hazard statement provides information about a hazard and its consequences. It also explains how to avoid the hazard. It can also associate an image.

Specialization hierarchy

The <hazardstatement> element is specialized from <note>. It is defined in the hazard-statement domain module.

Content model

<messagepanel> +

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <li> , <linkinfo> , <lq> , <p> , <section> , <stentry>

One or more <messagepanel>

Contained by

Inheritance

+ topic/note hazard-d/hazardstatement

The <hazardstatement> element is specialized from <note> . It is defined in the hazard-domain module.

Attributes

The following attributes are available on this element: universal attributes and the attribute defined below.

@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section contains examples of how the <hazardstatement> element can be used.

Example 80. Simple hazard statement

The following code sample shows the markup for a hazard statement that warns about rotating blades:

<hazardstatement type="danger">
    <messagepanel>
        <typeofhazard>
            <hazardsymbol keyref="hazard-rotatingblade"/>
            Rotating blade</typeofhazard>
        <consequence>Moving parts can crush and cut.</consequence>
        <howtoavoid>Follow lockout procedure before servicing.</howtoavoid>
    </messagepanel>
</hazardstatement>
Example 81. Example of a hazard statement that contains multiple hazards

The following code sample generates an ANSI Z535.6 grouped safety message that specifies information about multiple hazards:

<hazardstatement type="warning">
    <messagepanel>
        <typeofhazard>
            <hazardsymbol keyref="hazard-electricshock"/>
            ELECTRIC SHOCK HAZARD</typeofhazard>
        <consequence>The equipment must be grounded. Improper grounding, setup, or usage of
                     the system can cause electric shock</consequence>
        <howtoavoid>
            <hazardsymbol keyref="hazard-groundpowersource"/>
            <ul>
                <li>Turn off and disconnect power at main switch before disconnecting any
                    cables or before servicing or installing any equipment.</li>
                <li>Connect only to grounded power sources.</li>
                <li>All electric wiring must be done by a qualified electrician and comply
                    with all local codes and regulations.</li>
            </ul>
        </howtoavoid>
    </messagepanel>
    <!-- ... -->
    <messagepanel>
        <typeofhazard>
            <hazardsymbol keyref="hazard-hotsurface"/>
            BURN HAZARD</typeofhazard>
        <consequence>Electric sufaces and fluid can become very hot during
                     operation.</consequence>
        <howtoavoid>
            To avoid burns:
            <ul>
                <li>Do not touch hot fluid or equipment.</li>
            </ul>
        </howtoavoid>
    </messagepanel>
</hazardstatement>

<hazardsymbol>

The <hazardsymbol> element specifies a graphic. The graphic might represent a hazard, a hazardous situation, a result of not avoiding a hazard, or any combination of these messages.

Usage information

When a <hazardsymbol> element is directly contained by <messagepanel>, the <hazardsymbol> is assumed to be associated with the <typeofhazard> element. Otherwise, the image is associated with the containing element.

Rendering expectations
Processors SHOULD scale the object when values are provided for the @height and @width attributes. The following expectations apply:
  • If a height value is specified and no width value is specified, processors SHOULD scale the width by the same factor as the height.
  • If a width value is specified and no height value is specified, processors SHOULD scale the height by the same factor as the width.
  • If both a height value and width value are specified, implementations MAY ignore one of the two values when they are unable to scale to each direction using different factors.
Specialization hierarchy

The <hazardsymbol> element is specialized from <image>. It is defined in the hazard-statement domain module.

Content model

<alt> ?, <longdescref> ?

Contained by

<consequence> , <howtoavoid> , <messagepanel> , <typeofhazard>

In order
  1. Optional <alt>
  2. Optional <longdescref>

Contained by

Inheritance

+ topic/image hazard-d/hazardsymbol

The <hazardsymbol> element is specialized from <image> . It is defined in the hazard-domain module.

Attributes

The following attributes are available on this element: universal attributes, @format, @href, @keyref, @scope, and the attributes defined below.

@align
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@placement
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit
Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.

For this element, @href specifies an image.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
For this element, @href specifies an image.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample defines a hazard statement that specifies an image that illustrates the type of hazard: 

<hazardstatement type="danger">
  <messagepanel>
    <typeofhazard>
      <hazardsymbol keyref="hazard-rotatingblade"/>
      Rotating blade</typeofhazard>
    <consequence>Moving parts can crush and cut.</consequence>
    <howtoavoid>Follow lockout procedure before servicing.</howtoavoid>
  </messagepanel>
</hazardstatement>

<howtoavoid>

The <howtoavoid> element contains information about how a user can avoid a hazard, for example, "Do not use solvents to clean the drum surface."

Specialization hierarchy

The <howtoavoid> element is specialized from <div>. It is defined in the hazard-statement domain module.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <sl> | <ol> | <ul> | <simpletable> | <hazardsymbol> )*

Contained by

<messagepanel>

Zero or more of the following

Contained by

Inheritance

+ topic/div hazard-d/howtoavoid

The <howtoavoid> element is specialized from <div> . It is defined in the hazard-domain module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows the markup for a hazard statement that warns about possible damage to machinery. The <howtoavoid> element provides specific information about what the reader needs to do to avoid the hazard.

<hazardstatement type="notice">
  <messagepanel>
    <typeofhazard>
      <hazardsymbol keyref="hazard-agressivesolvent"/>
      Machinery Damage</typeofhazard>
    <howtoavoid>
      <hazardsymbol keyref="hazard-readmanual"/>
      <ul>
        <li>Do NOT use solvents to clean the drum surface</li>
	 <li>Read manual for proper drum cleaning procedure</li>
      </ul>
    </howtoavoid>
  </messagepanel>
</hazardstatement>

<messagepanel>

The <messagepanel> element contains the textual information that is displayed on the hazard statement. This information identifies the hazard, specifies how to avoid the hazard, states the probable consequences of failing to avoid the hazard, and might specify one or more images.

Specialization hierarchy

The <messagepanel> element is specialized from <div>. It is defined in the hazard-statement domain module.

Content model

( <data> | <sort-as> )*, <typeofhazard> , (( <consequence> +, <howtoavoid> +) | ( <howtoavoid> +, <consequence> *)), <hazardsymbol> *

Contained by

<hazardstatement>

In order
  1. Zero or more of the following
  2. <typeofhazard>
  3. One of the following
  4. Zero or more <hazardsymbol>

Contained by

Inheritance

+ topic/div hazard-d/messagepanel

The <messagepanel> element is specialized from <div> . It is defined in the hazard-domain module.

Attributes

The following attributes are available on this element: universal attributes and @compact.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@compact
Specifies whether the vertical spacing between list items is tightened. The following values are valid: yes, no, and -dita-use-conref-target. Some DITA processors or output formats might not support the @compact attribute.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <hazardstatement>.

<typeofhazard>

The <typeofhazard> element contains a description of the type of hazard, for example, "Hot surfaces inside."

Specialization hierarchy

The <typeofhazard> element is specialized from <div>. It is defined in the hazard-statement domain module.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <tm> | <hazardsymbol> )*

Contained by

<messagepanel>

Zero or more of the following

Contained by

Inheritance

+ topic/div hazard-d/typeofhazard

The <typeofhazard> element is specialized from <div> . It is defined in the hazard-domain module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows the markup for a hazard statement that warns about a lifting hazard:

<hazardstatement type="caution">
  <messagepanel>
    <typeofhazard>
      <hazardsymbol keyref="hazard-heavyobject"/>
      Lifting hazard
    </typeofhazard>
    <consequence>May result in injury.</consequence>
    <howtoavoid>See safety manual for lifting instructions.</howtoavoid>
  </messagepanel>
</hazardstatement>

Highlighting domain elements

The highlighting elements are used to highlight text with styles such as bold, italic, and monospaced. These elements are intended solely for use by authors when no semantically appropriate element is available and a formatting effect is required.

<b>

Bold text is text that is used to draw a reader's attention to a phrase without otherwise adding meaning to the content.

Rendering expectations

The content of the <b> element is typically rendered in a bold font.

Specialization hierarchy

The <b> element is specialized from <ph>. It is defined in the highlighting-domain module.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <alt> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

+ topic/ph hi-d/b

The <b> element is specialized from <ph> . It is defined in the hi-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a <b> element used to draw a reader's attention to a phrase:

<p>Use the bold tag <b>for visual emphasis only</b>; do not use it if another phrase-level 
element better signifies the reason for the emphasis.</p>

<i>

Italic text is text that is used to emphasize the key points in printed text, or when quoting a speaker, to show which words the speaker stressed.

Rendering expectations

The content of the <i> element is typically rendered in an italic font.

Specialization hierarchy

The <i> element is specialized from <ph>. It is defined in the highlighting-domain module.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <alt> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

+ topic/ph hi-d/i

The <i> element is specialized from <ph> . It is defined in the hi-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows an <i>element used to indicate the use of a foreign word:

<note type="tip">Take care to measure the right amount when mixing ingredients.
A <i>laissez-faire</i> attitude to baking is a recipe for disaster.</note>

<line-through>

A strikethrough is a typographical presentation of words with a horizontal line through their center. It can indicate that words are a mistake and not intended for inclusion, or it can be used deliberately to imply a change of thought.

Usage information

The <line-through> element is designed to enable authors to indicate a deletion or revision for rhetorical purpose; it is not intended to be used for indicating revisions.

Rendering expectations

The content of the <line-through> element is rendered with a line struck through.. It is represented by the line-through value for the CSS text-decoration property.

Specialization hierarchy

The <line-through> element is specialized from <ph>. It is defined in the highlighting-domain module.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <alt> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

+ topic/ph hi-d/line-through

The <line-through> element is specialized from <ph> . It is defined in the hi-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a <line-through> element used to indicate a rhetorical revision:

<p>After writing up an angry post for social media, the author
  <line-through>wisely reconsidered</line-through> decided to wait a day before sharing.</p>

<overline>

An overline is a horizontal line that is printed above a line of text, a mathematical symbol, or an illustration in a newspaper or journal.

Rendering expectations

The content of the <overline> element is typically rendered with a line above it.

Specialization hierarchy

The <overline> element is specialized from <ph>. It is defined in the highlighting-domain module.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <alt> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

+ topic/ph hi-d/overline

The <overline> element is specialized from <ph> . It is defined in the hi-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows an <overline > element used to provide the highlighting used for mathematical notation:

<p>Overline: <overline><i>x</i></overline> is the 
average value of<i>x<sub>i</sub></i></p>

<sub>

A subscript is text that is printed below the line. It is frequently used in chemical and mathematical formulas.

Rendering expectations

The content of the <sub> element is typically rendered lower in relationship to the surrounding text and in a smaller font.

Specialization hierarchy

The <sub> element is specialized from <ph>. It is defined in the highlighting-domain module.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <alt> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

+ topic/ph hi-d/sub

The <sub> element is specialized from <ph> . It is defined in the hi-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how the <sub> element is used in a chemical formula:

<note>When cleaning, be sure to dilute the baking soda (NaHCO<sub>3</sub>) with water
(H<sub>2</sub>O) before mixing in the vinegar (CH<sub>3</sub>COOH).</note>

<sup>

A superscript is text that is printed above the line. It is frequently used in chemical and mathematical formulas.

Rendering expectations

The content of the <sup> element is typically rendered higher in relationship to the surrounding text and in a smaller font.

Specialization hierarchy

The <sup> element is specialized from <ph>. It is defined in the highlighting-domain module.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <alt> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

+ topic/ph hi-d/sup

The <sup> element is specialized from <ph> . It is defined in the hi-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a <sup> element used to ensure proper formatting of the exponent in the number ten to the power of five:

<p>The power produced by the electrohydraulic dam was 10<sup>5</sup> more than 
the older electric plant.</p>

<tt>

Teletype text is text that is displayed on a fixed-width display such as a teletype, text-only screen, or line printer.

Rendering expectations

The content of the <tt> element is typically rendered in a monospaced font.

Specialization hierarchy

The <tt> element is specialized from <ph>. It is defined in the highlighting-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

Example

This section is non-normative.

The following code sample shows how the <tt> element can be used to apply monospaced highlighting:

<p>Make sure that the screen displays <tt>File successfully created</tt> before
proceeding to the next stage of the task.</p>

While the example demonstrates a potential use of <tt>, use <systemoutput> if you have access to the elements in the software domain.

<u>

An underline, also called an underscore, is a line immediately below a portion of text.

Rendering expectations

The content of the <u> element is typically underlined.

Specialization hierarchy

The <u> element is specialized from <ph>. It is defined in the highlighting-domain module.

Content model

(Text | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <draft-comment> | <foreign> | <required-cleanup> )*

Contained by

<abstract> , <alt> , <b> , <bodydiv> , <cite> , <consequence> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

+ topic/ph hi-d/u

The <u> element is specialized from <ph> . It is defined in the hi-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows underlining used to provide emphasis in a marketing blurb, without giving any extra meaning to the underlined phrase:

<p>Using our patented <u>SuperFast BitSpeed Technology</u>, our product
will answer all of your questions only a few nanoseconds after you ask!</p>

Mapgroup domain elements

The mapgroup domain elements define, group, or reference content. Many of the mapgroup elements are convenience elements; they simply provide shortcuts for an author to use existing markup.

For example, the <topichead> element enables a map to specify a heading without a reference to a topic. While a <topicref> element might accomplish the same thing by creating a title and leaving off the @href attribute, the <topichead> element makes the intent clearer and prevents the accidental inclusion of an @href attribute.

<keydef>

A key definition provides a simple way to define a key without making the definition itself a part of rendered content.

Usage information

The <keydef> element is a convenience element. It is equivalent to a <topicref> element that defines a key while also setting @processing-role to resource-only.

Attributes defaulted on the <keydef> element ensure that key definitions do not appear in tables of contents, do not add extra links, and are not rendered as topics.

Specialization hierarchy

The <keydef> element is specialized from <topicref>. It is defined in the mapgroup-domain module.

Content model

<topicmeta> ?, ( <data> | <navref> | <topicref> | <ditavalref> | <keydef> | <mapref> | <mapresources> | <topicgroup> | <topichead> )*

Contained by

<keydef> , <map> , <mapresources> , <relcell> , <relcolspec> , <topicgroup> , <topichead> , <topicref>

In order
  1. Optional <topicmeta>
  2. Zero or more of the following

Contained by

Inheritance

+ map/topicref mapgroup-d/keydef

The <keydef> element is specialized from <topicref> . It is defined in the mapgroup-domain module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, @impose-role, and @keyref.

For this element, the following considerations apply:
  • The @impose-role attribute has a fixed value of keeptarget.
  • The @keys attribute is required.
  • The @href attribute might be omitted when the key definition is used for variable text.
  • The @processing-role attribute has a default value of resource-only.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
The @href attribute might be omitted when the key definition is used for variable text.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@impose-role
Specifies whether this element will impose its role on elements in a referenced map. The attribute is ignored if the target of the reference is not a map or branch of a map. The following values are valid:
keeptarget
The role of the current reference is not imposed on the target of the reference. This is the default for the unspecialized <topicref> element and for many convenience elements such as <keydef>.
impose
The role of the current reference is imposed on the target of the reference. For example, if a specialized topic reference <chapter> uses this value and references a map, a topic reference that resolves in place of the <chapter> will be treated as if it were a chapter.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The href attribute for detailed information on supported values and processing implications.

The @impose-role attribute has a fixed value of keeptarget.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@keys
The @keys attribute is required.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

The @processing-role attribute has a default value of resource-only.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows several different types of key definitions:

<map>
  <title>Possible keys for use in the DITA specification</title>
  <!-- Key definition #1-->
  <keydef keys="dita-tc" scope="external" format="html"
          href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita">
    <topicmeta>
      <keytext>DITA Technical Committee</keytext>
    </topicmeta>
  </keydef>
  <!-- Key definition #2-->
  <keydef keys="addressing" href="dita-addressing.dita"/>
  <!-- Key definition #3-->
  <keydef keys="dita-version">
    <topicmeta>
      <keytext>2.0</keytext>
    </topicmeta>
  </keydef>
</map>
  1. The first <keydef> element defines a key that links to a web page. It contains link text; it also specifies the necessary @scope and @format attributes, so that authors do not need to include them when they reference this key.
  2. The second <keydef> element defines a key for a local DITA topic about addressing in DITA; that topic is available to resolve link text.
  3. The third <keydef> element defines a text-only key that specifies the current DITA version number.

<mapref>

A map reference is a mechanism for referencing a DITA map from a DITA map.

Usage information

The <mapref> element is a convenience element. It is equivalent to a <topicref> element with the @format attribute set to ditamap.

Processing expectations

The hierarchy of the referenced map is merged into the container map at the position of the reference, and the relationship tables of the child map are added to the parent map.

Specialization hierarchy

The <mapref> element is specialized from <topicref>. It is defined in the mapgroup-domain module.

Content model

<topicmeta> ?, <data> **

Contained by

<keydef> , <map> , <mapresources> , <relcell> , <relcolspec> , <topicgroup> , <topichead> , <topicref>

In order
  1. Optional <topicmeta>
  2. Zero or more Zero or more <data>

Contained by

Inheritance

+ map/topicref mapgroup-d/mapref

The <mapref> element is specialized from <topicref> . It is defined in the mapgroup-domain module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, @impose-role, @keyref, and @keys.

For this element:
  • The @format attribute has a default value of ditamap.
  • The @impose-role attribute has a fixed value of keeptarget.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
The @format attribute has a default value of ditamap.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@impose-role
Specifies whether this element will impose its role on elements in a referenced map. The attribute is ignored if the target of the reference is not a map or branch of a map. The following values are valid:
keeptarget
The role of the current reference is not imposed on the target of the reference. This is the default for the unspecialized <topicref> element and for many convenience elements such as <keydef>.
impose
The role of the current reference is imposed on the target of the reference. For example, if a specialized topic reference <chapter> uses this value and references a map, a topic reference that resolves in place of the <chapter> will be treated as if it were a chapter.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The href attribute for detailed information on supported values and processing implications.

The @impose-role attribute has a fixed value of keeptarget.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@keys
Specifies one or more names for a resource. See Setting key names with the keys attribute for information on using this attribute.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how a <mapref> element can be used to reference a submap. The base-elements.ditamap document references the map-group-elements.ditamap):

<map>
 <title>Base elements</title>
 <!-- ... -->
 <topicref href="containers/domain-elements.dita" >
  <!-- ... -->
  <mapref href="map-group-elements.ditamap"/>
  <!-- ... -->
 </topicref>
 <!-- ... -->
</map>

The map-group-elements.ditamap document contains references to the element-reference topics for the map group domain. It is constructed as a map in order to enable easy editing of the child topics. 

<map>
 <title>Map group elements</title>
 <topicref keyref="mapgroup-d" >
  <topicref keyref="keydef" />
  <topicref keyref="mapref" />
  <topicref keyref="topicgroup" />
  <topicref keyref="topichead" />
 </topicref>
</map>

After processing, the base-elements.ditamap contains the topic references that originally were located in the submap:

<map>
 <title>Base elements</title>
 <!-- ... -->
 <topicref href="containers/domain-elements.dita" >
  <!-- ... -->
  <topicref keyref="mapgroup-d" >
    <topicref keyref="keydef" />
    <topicref keyref="mapref" />
    <topicref keyref="topicgroup" />
    <topicref keyref="topichead" />
  </topicref>
  <!-- ... -->
 </topicref>
 <!-- ... -->
</map>

<mapresources>

Map resources are objects with a @processing-role set to resource-only, for example, key definitions and subject scheme maps. Such resources do not contribute to the navigation structure, although they might be essential for authoring and processing.

Specialization hierarchy

The <mapresources> element is specialized from <topicref>. It is defined in the mapgroup-domain module.

Content model

<topicmeta> ?, ( <data> | <topicref> | <ditavalref> | <keydef> | <mapref> | <mapresources> | <topicgroup> | <topichead> )*

Contained by

<keydef> , <map> , <mapresources> , <relcell> , <relcolspec> , <topicgroup> , <topichead> , <topicref>

In order
  1. Optional <topicmeta>
  2. Zero or more of the following

Contained by

Inheritance

+ map/topicref mapgroup-d/mapresources

The <mapresources> element is specialized from <topicref> . It is defined in the mapgroup-domain module.

Attributes

The following attributes are available on this element: common map attributes (excluding @chunk and @collection-type), link-relationship attributes, universal attributes, @impose-role, @keyref, and @keys.

For this element, the @processing-role attribute has a default value of resource-only.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@href (link-relationship attributes)
Specifies a reference to a resource. See The href attribute for detailed information on supported values and processing implications.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@impose-role
Specifies whether this element will impose its role on elements in a referenced map. The attribute is ignored if the target of the reference is not a map or branch of a map. The following values are valid:
keeptarget
The role of the current reference is not imposed on the target of the reference. This is the default for the unspecialized <topicref> element and for many convenience elements such as <keydef>.
impose
The role of the current reference is imposed on the target of the reference. For example, if a specialized topic reference <chapter> uses this value and references a map, a topic reference that resolves in place of the <chapter> will be treated as if it were a chapter.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

See The href attribute for detailed information on supported values and processing implications.

@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@keys
Specifies one or more names for a resource. See Setting key names with the keys attribute for information on using this attribute.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

For this element, the @processing-role attribute has a default value of resource-only.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Examples

This section is non-normative.

This section provides examples of how the <mapresources> element can be used.

Example 82. Specifying resource-only objects in an intuitive location in a book map

The following code sample illustrate how the <mapresources> element can group references to key definitions, subject schemes, and other resources in a bookmap:

<bookmap>
  <booktitle>
    <mainbooktitle>Test bookmap</mainbooktitle>
  </booktitle>
  <mapresources>
    <mapref href="key-definitions.ditamap"/>
    <mapref href="subject-scheme.ditamap" type="subjectscheme"/>
    <topicref href="cover-page.dita outputclass="cover-page"/>
  </mapresources>
  <!-- ... -->
</bookmap>

Note that this example illustrates that <mapresources> can be used to make topics available for resource-only processing. In this scenario, the company uses a processor that uses content contained in the cover-page.dita file to generate a PDF cover page.

Example 83. Specifying resource-only objects in a map

The following code sample shows a map that contains information for a specific model of a controller. This map is referenced in an omnibus publication that contains information for an entire family of controllers.

<map keyscope="model-XNP09">
  <title>Model XNP09</title>
  <mapresources>
    <keydef keys="model-illustration" href="model-XNP09.png" format="png"/>
    <keydef keys="remove-cover" href="remove-cover-XNP09.png" format="png"/>
  </mapresources>
  <topicref href="model-overview.dita/>
  <topicref href="installing.dita"/>
  <topicref href="uninstalling.dita/>
  ...
</map>

<topicgroup>

A topic group is a set of topic references that share common attributes and linking relationships.

Usage information

The <topicgroup> element is a convenience element. It is equivalent to a <topicref> element without a navigation title or @href, @keys, or @keyref attributes.

The <topicgroup> element does not affect the navigation hierarchy of the map.

Most <titlealt> elements within the <topicmeta> element inside of a <topicgroup> have no effect on rendered publications, but they can be used to hold descriptive information about the grouped <topicref> elements.

Rendering expectations

When a map that contains a <topicgroup> element with a navigation title is used to generate publication output, processors MUST ignore the navigation title and MAY issue an error message.

Specialization hierarchy

The <topicgroup> element is specialized from <topicref>. It is defined in the mapgroup-domain module.

Content model

<topicmeta> ?, ( <data> | <navref> | <topicref> | <ditavalref> | <keydef> | <mapref> | <mapresources> | <topicgroup> | <topichead> )*

Contained by

<keydef> , <map> , <mapresources> , <relcell> , <relcolspec> , <topicgroup> , <topichead> , <topicref>

In order
  1. Optional <topicmeta>
  2. Zero or more of the following

Contained by

Inheritance

+ map/topicref mapgroup-d/topicgroup

The <topicgroup> element is specialized from <topicref> . It is defined in the mapgroup-domain module.

Attributes

The following attributes are available on this element: common map attributes, universal attributes, @format, @scope, and @type.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In the following code sample, the <topicgroup> element specifies common attributes (@audience and @linking) that are inherited by the topic references. The navigation hierarchy is not affected.

<topicgroup audience="novice" linking="none">
  <topicmeta>
    <titlehint>Topics used only in "Getting started" material.</titlehint>
  </topicmeta>
  <topicref href="getting-started.dita"/>
  <topicref href="basic-concepts.dita"/>
  <topicref href="cheat-sheet-reference.dita"/>
</topicgroup>

<topichead>

A topic head is a title-only entry in a DITA map.

Usage information

The <topichead> element is a convenience element. It is equivalent to a <topicref> element with the following components:

  • A navigation title
  • No @href, @keys, or @keyref attributes
Rendering expectations

When the navigation title associated with a <topichead> element is rendered, it appears as a heading in a table of contents. In print contexts, it also appears as a heading in the rendered body content.

Processing expectations

Processors SHOULD generate a warning if a navigation title is not specified on a <topichead> element.

Specialization hierarchy

The <topichead> element is specialized from <topicref>. It is defined in the mapgroup-domain module.

Content model

<topicmeta> ?, ( <data> | <navref> | <topicref> | <ditavalref> | <keydef> | <mapref> | <mapresources> | <topicgroup> | <topichead> )*

Contained by

<keydef> , <map> , <mapresources> , <relcell> , <relcolspec> , <topicgroup> , <topichead> , <topicref>

In order
  1. Optional <topicmeta>
  2. Zero or more of the following

Contained by

Inheritance

+ map/topicref mapgroup-d/topichead

The <topichead> element is specialized from <topicref> . It is defined in the mapgroup-domain module.

Attributes

The following attributes are available on this element: common map attributes, universal attributes, @format, @scope, and @type.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge
Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge
Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@chunk (common map attributes)
Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.
The following values are valid:
combine
Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split
Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)
Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:
unordered
Indicates that the order of the child topics is not significant.
sequence
Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice
Indicates that one of the children should be selected.
family
Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@format (link-relationship attributes)
Specifies the format of the resource that is referenced. See The format attribute for detailed information on supported values and processing implications.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@keyscope (common map attributes)
Specifies that the element marks the boundaries of a key scope.

See The keyscope attribute for information on using this attribute.

@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@linking (common map attributes)
Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@processing-role (common map attributes)
Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:
normal
Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only
Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See The scope attribute for detailed information on supported values and processing implications.

@search (common map attributes)
Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@subjectrefs (common map attributes)
Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@toc (common map attributes)
Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:
yes
The topic appears in a generated TOC.
no
The topic does not appear in a generated TOC.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In the following example, the <topichead> elements provide titles ("Computers" and "Books") for two groups of topics:

<map>
  <topichead>
    <topicmeta>
      <navtitle>Computers</navtitle>
    </topicmeta>
    <topicref href="eniac.dita"/>
    <topicref href="system360.dita"/>
    <topicref href="pdp8.dita"/>
  </topichead>
  <topichead>
    <topicmeta>
      <navtitle>Books</navtitle>
    </topicmeta>
    <topicref href="hardback.dita"/>
    <topicref href="paperback.dita"/>
  </topichead>
</map>

Utilities domain elements

The utilities domain elements are used to describe image maps and enable sorting.

<area>

The <area> element defines a linkable region in an image map.

Usage information

Each area in an image map specifies the shape and coordinates of the linkable region, as well as the link target and its link text.

Specialization hierarchy

The <area> element is specialized from <div>. It is defined in the utilities domain module.

Content model

<shape> , <coords> , <xref>

Contained by

<imagemap>

In order
  1. <shape>
  2. <coords>
  3. <xref>

Contained by

Inheritance

+ topic/div ut-d/area

The <area> element is specialized from <div> . It is defined in the ut-domain module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how the <area> element defines the linkable region in an image map. It defines the shape and coordinates of the linkable region, and it specifies the link target and its link text.

<area>
  <shape>rect</shape>
  <coords>276, 60, 425, 460</coords>
  <xref format="html" scope="external"
        href="https://en.wikipedia.org/wiki/Willem_van_Ruytenburch">
        Willem van Ruytenburch</xref>
</area>

<coords>

The <coords> element specifies the coordinates of a linkable region in an <imagemap>.

Usage information

The values for use in the <coords> element are defined by the HTML5 specification. The unit used for coordinates is CSS pixels. The following table provides a summary of the syntax, which depends on the shape of the linkable region:

Shape Syntax
circle Three integers, separated by commas:
  1. The distance from the left edge of the image to the center of the circle
  2. The distance from the top edge of the image to the center of the circle
  3. The radius of the circle
default The default shape is the entire image. The <coords> element should be empty.
poly An even number of at least six integers, separated by commas:
  • Each pair of integers represents a coordinate given as the distances from the left and the top of the image respectively.
  • The coordinates represent the points of the polygon, in order.
rect Four integers, separated by commas:
  1. The distance from the left edge of the image to the left side of the rectangle
  2. The distance from the top edge of the image to the top side of the rectangle
  3. The distance from the left edge of the image to the right side of the rectangle
  4. The distance from the top edge of the image to the bottom side of the rectangle
Specialization hierarchy

The <coords> element is specialized from <ph>. It is defined in the utilities-domain module.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> )*

Contained by

<area>

Zero or more of the following

Contained by

Inheritance

+ topic/ph ut-d/coords

The <coords> element is specialized from <ph> . It is defined in the ut-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

For this element, the @translate attribute has a default value of no.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate
For this element, the @translate attribute has a default value of no.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how the <coords> element specifies the coordinates of a polygonal region in an image map:

<area>
  <shape>poly</shape>
  <coords>119, 4, 90, 7, 87, 20, 53, 36, 45, 51, 7, 188, 12, 467,
          223, 464, 240, 315, 223, 254, 210, 168, 193, 146, 173, 121, 167,
          87, 169, 70, 181, 57, 189, 35, 164, 24, 140, 4
  </coords>
  <xref format="html" scope="external"
        href="https://en.wikipedia.org/wiki/Frans_Banninck_Cocq">
        Willem van Ruytenburch</xref>
</area>

<imagemap>

A image map is an image with areas that are linked to DITA topics, web pages, PDFs, or any other resources that can be targeted by the @href attribute.

Usage information

A DITA image map references the image, followed by a series of <area> elements that define the linkable regions of the image. Each <area> element specifies the shape and coordinates of the region, as well as the link target and link text.

Rendering expectations

The rendering expectations for the <imagemap> element depends on the output format. For HTML-based formats, it can be rendered as standard HTML images or as an alternate form of navigation, such as table-based image maps. For print-based formats, it can be rendered as an image and a list of the specified link targets.

Specialization hierarchy

The <imagemap> element is specialized from <div>. It is defined in the utilities domain module.

Content model

<image> , <area> +

Contained by

<abstract> , <body> , <bodydiv> , <dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <li> , <linkinfo> , <lq> , <note> , <p> , <section> , <stentry>

In order
  1. <image>
  2. One or more <area>

Contained by

Inheritance

+ topic/div ut-d/imagemap

The <imagemap> element is specialized from <div> . It is defined in the ut-domain module.

Attributes

The following attributes are available on this element: display attributes and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@expanse (display attributes)
Specifies the horizontal placement of the element. The following values are valid:
column
Indicates that the element is aligned with the current column margin.
page
Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
spread
Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
textline
Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

For <table>, in place of the @expanse attribute that is used by other DITA elements, the @pgwide attribute is used in order to conform to the OASIS Exchange Table Model.

Some processors or output formats might not support all values.

@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@frame (display attributes)
Specifies which portion of a border surrounds the element. The following values are valid:
all
Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
bottom
Indicates that a line is rendered at the bottom of the containing element.
none
Indicates that no lines are rendered.
sides
Indicates that a line is rendered at the left and right of the containing element.
top
Indicates that a line is rendered at the top of the containing element.
topbot
Indicates that a line is rendered at the top and bottom of the containing element.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

Some processors or output formats might not support all values.

@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

Specifies the percentage by which fonts are resized in relation to the normal text size. The value of this attribute is a positive integer. When used on <table> or <simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.

This attribute is primarily useful for print-oriented display. Some processors might not support all values.

If the @scale attribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the <image> element.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

This section contains examples of how the <imagemap> element can be used:

Example 84. Example: Image map that uses the circle, rectangle, and polygon shapes

The following code sample shows an image map for a detail of Rembrandt's "The Night Watch":

<imagemap id="the-night-watch">
  <image href="Detail_from_The_Night_Watch.jpg" id="night_watch">
    <alt>Detail from Rembrandt's The Night Watch</alt>
  </image>
  <!-- Area #1: Frans Banninck Cocq -->
  <area>
    <shape>poly</shape>
    <coords>119, 4, 90, 7, 87, 20, 53, 36, 45, 51, 7, 188, 12, 467,
          223, 464, 240, 315, 223, 254, 210, 168, 193, 146, 173, 121, 167,
          87, 169, 70, 181, 57, 189, 35, 164, 24, 140, 4</coords>
    <xref format="html" scope="external"
          href="https://en.wikipedia.org/wiki/Frans_Banninck_Cocq">
          Frans Banninck Cocq</xref>
  </area>
  <!-- Area #2: A member of the schutterij (the night watch) -->
  <area>
    <shape>circle</shape>
    <coords>223, 98, 48</coords>
    <xref format="html" scope="external"
          href="https://en.wikipedia.org/wiki/Schutterij">A member of the
          schutterij (the night watch)</xref>
  </area>
  <!-- Area #3: Willem_van_Ruytenburch -->
  <area>
    <shape>rect</shape>
    <coords>276, 60, 425, 460</coords>
    <xref format="html" scope="external"
          href="https://en.wikipedia.org/wiki/Willem_van_Ruytenburch">
          Willem van Ruytenburch</xref>
  </area>
</imagemap>

The following image shows the areas that are defined by the image map. Each of the three supported shapes are used.


A screen capture of the image map as rendered in Oxygen Editor, showing the three defined areas

The following table lists the defined areas, the shape used, alternate text, and link targets:

Area Shape Alternate text Link target
1 Polygon Frans Banninck Cocq Wikipedia entry for Frans Banninck Cocq
2 Circle A member of the schutterij (the night watch) Wikipedia entry for Schutterij
3 Rectangle Willem van Ruytenburch Wikipedia entry for Willem van Ruytenburch
Example 85. Example: Image map with the default shape

The following code sample shows an image map that specifies that the entire image is the linkable region. Because the default shape is specified, the <coords> element is empty.

<imagemap id="portrait">
  <image keyref="bronte-sisters">
    <alt>Portrait of the Bronte sisters</alt>
  </image>
  <area>
    <shape>default</shape>
    <coords/>
    <xref keyref="wiki-bronte-sisters"/>
  </area>
</imagemap>

<shape>

The <shape> element defines the shape of a linkable region in an image map.

Usage information

The values for use in the <shape> element are defined by the HTML5 specification. The following values are supported as the content of the <shape> element:

circle
Indicates that the linkable region is a circle
default
Indicates the linkable region is a rectangle that exactly covers the entire image
poly
Indicates that the linkable region is a polygon
rect
Indicates that the linkable region is a rectangle

If the <shape> element is left empty, a rectangular shape is assumed.

Specialization hierarchy

The <shape> element is specialized from <keyword>. It is defined in the utilities domain module.

Content model

(Text | <text> )*

Contained by

<area>

Zero or more of the following

Contained by

Inheritance

+ topic/keyword ut-d/shape

The <shape> element is specialized from <keyword> . It is defined in the ut-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

For this element, the @translate attribute has a default value of no.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate
For this element, the @translate attribute has a default value of no.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

See <imagemap>.

<sort-as>

The <sort-as> element can be used to specify an effective sort phrase when the base sort phrase is not appropriate for sorting, for example, Japanese characters. This element prepends text to the base sort phrase in order to construct an effective sort phrase.

Usage information

Sort text can be specified in the content of the <sort-as> element or in the @value attribute on the <sort-as> element. The <sort-as> element is also useful for elements where the base sort phrase is inadequate or non-existent, such as an index entry for a Japanese Kanji phrase.

If a <keyword> element is used within <sort-as>, the @keyref attribute can be used to set the sort phrase. If a <keyword> uses @keyref and would otherwise also act as a navigation link, the link aspect of the @keyref attribute is ignored.

Some elements in the base DITA vocabulary are natural candidates for sorting, including topics, definition list entries, index entries, and rows in tables and simple tables. Authors are likely to include <sort-as> elements in the following locations:

  • For topics, the <sort-as> element can be included directly in <title> or <titlealt> when the different forms of title need different effective sort phrases. If the effective sort phrase is common to all the titles for a topic, the <sort-as> element can be included as a direct child of the <prolog> element in the topic.
  • For topic references, the <sort-as> element can be included directly in the <titlealt> element with a @title-role of navigation, such as <navtitle>, within <topicmeta> or as a child of <topicmeta>.
  • For glossary entry topics, the <sort-as> element can be included directly in <glossterm> or as a direct child of the <prolog> element.
  • For definition list items, the <sort-as> element can be included in the <dt> element.
  • For index entries, the <sort-as> can be included as a child of <indexterm>. In a multilevel <indexterm> element, the <sort-as> element only affects the level in which it occurs.
Processing expectations

If the @value attribute is not specified and the <sort-as> element does not contain content, then the <sort-as> element has no effect.

As a specialization of <data>, the <sort-as> element is allowed in any context where <data> is allowed. However, the presence of <sort-as> within an element does not necessarily indicate that the containing element should be sorted. Processors can choose to sort any DITA elements for any reason. Likewise, processors are not required to sort any elements.

Processors SHOULD expect to encounter <sort-as> elements in the above locations. Processors that sort SHOULD use the following precedence rules:
  • A <sort-as> element that is specified in a title takes precedence over a <sort-as> element that is specified as a child of the topic prolog.
  • Except for instances in the topic prolog, processors only apply <sort-as> elements that are either a direct child of the element to be sorted or a direct child of the title- or label-defining element of the element to be sorted.
  • When an element contains multiple, direct-child, <sort-as> elements, the first direct-child <sort-as> element in document order takes precedence.

  • It is an error if there is more than one <sort-as> child for a given <indexterm> element.

  • Sort phrases are determined after filtering and content reference resolution occur.

When a <sort-as> element is specified, processors that sort the containing element MUST construct the effective sort phrase by prepending the content of the <sort-as> element to the base sort phrase. This ensures that two items with the same <sort-as> element but different base sort phrases will sort in the appropriate order.

For example, if a processor uses the content of the <title> element as the base sort phrase, and the title of a topic is "24 Hour Support Hotline" and the value of the <sort-as> element is "twenty-four hour", then the effective sort phrase would be "twenty-four hour24 Hour Support Hotline".

Specialization hierarchy

The <sort-as> element is specialized from <data>. It is defined in the utilities-domain module.

Content model

(Text | <text> | <keyword> )*

Contained by

<abstract> , <alt> , <author> , <b> , <body> , <bodydiv> , <brand> , <category> , <cite> , <component> , <consequence> , <coords> , <copyrholder> , <data> , <dd> , <ddhd> , <desc> , <div> , <dl> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <featnum> , <fig> , <figgroup> , <fn> , <i> , <include> , <index-see> , <index-see-also> , <indexterm> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <messagepanel> , <metadata> , <navtitle> , <note> , <ol> , <overline> , <p> , <ph> , <platform> , <pre> , <prodname> , <prognum> , <prolog> , <publisher> , <q> , <resourceid> , <searchtitle> , <section> , <series> , <shortdesc> , <sl> , <sli> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <ul> , <xref>

Zero or more of the following

Contained by

Inheritance

+ topic/data ut-d/sort-as

The <sort-as> element is specialized from <data> . It is defined in the ut-domain module.

Attributes

The following attributes are available on this element: universal attributes, @name, and @value.

For this element,
  • The @name attribute has a default value of sort-as.
  • The @value attribute specifies text to combine with the base sort phrase to create an effective sort phrase. When the <sort-as> element has content and the @value attribute is specified, the @value attribute takes precedence.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
Defines a unique name for the object.
The @name attribute has a default value of sort-as.
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
Specifies a value associated with the current property or element.
The @value attribute specifies text to combine with the base sort phrase to create an effective sort phrase. When the <sort-as> element has content and the @value attribute is specified, the @value attribute takes precedence.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following examples illustrate how a glossary entry for the Chinese ideographic character for big might specify an effective sort phrase of dada (the Pin-Yin transliteration for Mandarin):

Example 86. <sort-as> within <glossterm>

In the following code sample, the <sort-as> element is located within the <glossterm> element:

<glossentry id="gloss-dada">
  <glossterm>
    <sort-as value="dada"/>
    &#x5927;&#x5927;
  </glossterm>
  <glossdef>Literally "big big".</glossdef>
</glossentry>
Example 87. <sort-as> within <prolog>

In the following code sample, the <sort-as> element is located within the <prolog> element of the glossary entry topic:

<glossentry id="gloss-dada">
  <glossterm>&#x5927;&#x5927;</glossterm>
  <glossdef>Literally "big big".</glossdef>
  <prolog>
    <sort-as>dada</sort-as>
  </prolog>
</glossentry>

Other elements

Legacy conversion elements

Conversion elements exist primarily to aid in the conversion of content to DITA.

<required-cleanup>

Required cleanup sections are placeholders for migrated elements that cannot be appropriately tagged without manual intervention, or for content that must be cleaned up before publishing.

Usage information

As the element name implies, the intent for authors is to clean up the contained material and eventually remove the <required-cleanup> element.

Rendering expectations

Processors MUST strip this element from output by default. The content of <required-cleanup> is not considered to be publishable data.

Processing expectations

Processor options might be provided to allow a draft view of migrated content in context.

Content model

Any

Contained by

<abstract> , <alt> , <b> , <body> , <bodydiv> , <cite> , <data> , <dd> , <ddhd> , <desc> , <div> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <figgroup> , <fn> , <i> , <keyword> , <li> , <line-through> , <lines> , <linkinfo> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <pre> , <q> , <searchtitle> , <section> , <shortdesc> , <sli> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <term> , <title> , <titlealt> , <titlehint> , <tt> , <u> , <xref>

Any content

Contained by

Inheritance

- topic/required-cleanup

The <required-cleanup> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes and the attribute defined below.

@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.

For this element, the @translate attribute has a default value of no.

The following attributes are available on this element: universal attributes and the attributes defined below.

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

In the following example, an HTML document that used the <center> element was migrated to DITA. Because DITA has no clear equivalent element, the content is stored in <required-cleanup> until it can be marked up appropriately.

<section>
  <title>Using the display</title>
    <required-cleanup remap="center">If you cannot read
    your display, see "Adjusting the language setting"
    before you continue.</required-cleanup>
</section>

DITAVAL elements

A DITAVAL document identifies content that is filtered and flagged at rendering time. The DITAVAL document has an extension of .ditaval.

<alt-text>

The <alt-text> element in a DITAVAL document specifies alternate text for an image that is used to flag content. If an image is not specified, the text is used to mark the flagged content.

Rendering expectations

If no alternate text is specified, processors can provide default alternate text to indicate the start and end point of the flagged content.

Content model

Text

Contained by

<endflag> , <startflag>

Text

Contained by

  • <endflag>
  • <startflag>
Attributes

None

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a DITAVAL document that is used to render icons before content that is specific to particular audiences. The <alt-text> element provides alternate text for the icons:

<val>
  <prop action="flag" att="audience" val="novice">
    <startflag imageref="novice-icon.gif">
      <alt-text>Novice</alt-text>
    </startflag>
  </prop>
  <prop action="flag" att="audience" val="expert">
    <startflag imageref="expert-icon.gif">
      <alt-text>Expert</alt-text>
    </startflag>
</val>

<endflag>

The <endflag> element in a DITAVAL document specifies information that identifies the end of flagged content. The information can be an image, alternate text, or both.

Usage information

If the <endflag> element does not specify an image or provide alternate text, the element has no defined purpose.

Rendering expectations

Processors treat the information provided by the <endflag> element in the following way:

  • If an image is specified, the image is used as a flag to identify the end of the flagged content. If the <alt-text> element contains content, the content is used as alternate text for the image.
  • If alternate text is specified but the <endflag> element does not specify an image, the alternate text is used to indicate the end of the flagged content.
Content model

<alt-text> ?

Contained by

<prop> , <revprop>

Optional <alt-text>

Contained by

  • <prop>
  • <revprop>
Attributes

The following attribute is available on this element:

@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a DITAVAL document that is used to flag content that applies to administrators. The <startflag> and <endflag> elements provide text that is used to indicate the start and end point of the flagged content.

<val>
  <prop action="flag" att="audience" val="administrator">
    <startflag>
      <alt-text>Administrator content</alt-text>
    </startflag>
    <endflag>
      <alt-text>End of administrator content</alt-text>
    </endflag>
  </prop>
</val>

<prop>

The <prop> element in a DITAVAL document specifies filtering or flagging actions that occur when rendering. The actions target the @props attribute or specializations of @props, including @audience, @deliveryTarget, @otherprops, @platform, and @product.

Usage information

The following table lists the functions that are performed by the <prop> element in a DITAVAL document:

Markup Result
A <prop> element that specifies both an @att and a @val attribute Specifies an action (exclude, flag, include, or pass through) for the attribute or attribute group with the specified value
A <prop> element that specifies only an @att attribute Sets a default action for the specified attribute or attribute group
A <prop> element without an @att and @val attribute Sets a default action for all conditional-processing attributes not explicitly specified in the DITAVAL document
Rendering expectations
For the @color and @backcolor attributes on <prop> and <revprop>, processors SHOULD support at least the following values:
For the @style attribute on <rev> and <revprop>, processors SHOULD support the following tokens:
  • bold
  • double-underline
  • italics
  • overline
  • underline

In addition, processors MAY support proprietary tokens for the @style attribute. Such tokens SHOULD have a processor-specific prefix to identify them as proprietary. If a processor encounters an unsupported style token, it MAY issue a warning, and it MAY render content that is flagged with such a style token by using some default formatting.

Processing expectations
The following markup in a DITAVAL document is an error condition:
  • More than one <prop> element with no @att attribute
  • More than one <prop> element with the same @att attribute and no value
  • More than one <prop> element with the same @att attribute and same @value
Processors MAY provide an error or warning message for these error conditions.

The following list outlines how processors apply @outputclass flags:

  • If one or more DITAVAL properties apply @outputclass flags to the same element, and the element already specifies one or more values for the @outputclass attribute, processors treat the element as if the tokens for the @outputclass attribute that were provided in the DITAVAL document are specified first.
  • If two or more DITAVAL properties apply @outputclass flags to the same element, processors treat the element as if each value was specified for the @outputclass attribute. The order of the tokens for the @outputclass attribute that were provided in the DITAVAL document is undefined.
Content model

<startflag> ?, <endflag> ?

Contained by

<val>

In order
  1. Optional <startflag>
  2. Optional <endflag>

Contained by

  • <val>
Attributes

The following attributes are available on this element:

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.

The following attributes are only applicable when the @action attribute is set to flag. If the @action attribute is not set to flag, any value specified for these attributes are ignored.

@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a DITAVAL document that contains three <prop> elements:

<?xml version="1.0" encoding="UTF-8"?>
<val>
  <prop action="exclude"/>
  <prop action="passthrough" att="otherprops"/>
  <prop action="include" att="product" val="base-product"/>
</val>

The following list outlines the actions that the DITAVAL document specifies:

  1. Sets a default action of exclude. With the exception of the other conditions that are specified in the above DITAVAL document, the content of any element that specifies a conditional-processing attribute is excluded from the rendered output.
  2. Sets a default action of passthrough for the @otherprops attribute. The content of any element that specifies the @otherprops attribute is included in the output. In addition, the value for the @otherprops attribute is preserved in the rendered output, if supported by the output format.
  3. Sets an action of include for any element that specifies a value of base-product for the @product attribute. The content of any element that specifies a value of base-product for the @product attribute is included in the rendered output.

When a DITA map is processed using the above DITAVAL document, the following DITA elements are excluded:

  1. Any element for which the @audience, @deliveryTarget, @platform, and @props attributes (or specializations of @props) specify a non-null value.
  2. Any element for which the @product attribute specifies a value that is not equal to base-product.

All other content is included.

<revprop>

The <revprop> element in a DITAVAL document identifies a value of the @rev attribute for flagging. Unlike the conditional processing attributes, which can be used for both filtering and flagging, the @rev attribute can only be used for flagging.

Usage information

Neither the <reprop> element or the @rev attribute are designed to be used for version control.

Rendering expectations

If no alternate text is specified, processors can provide default alternate text to indicate the start and end point of the flagged content.

For the @color and @backcolor attributes on <prop> and <revprop>, processors SHOULD support at least the following values:
For the @style attribute on <rev> and <revprop>, processors SHOULD support the following tokens:
  • bold
  • double-underline
  • italics
  • overline
  • underline

In addition, processors MAY support proprietary tokens for the @style attribute. Such tokens SHOULD have a processor-specific prefix to identify them as proprietary. If a processor encounters an unsupported style token, it MAY issue a warning, and it MAY render content that is flagged with such a style token by using some default formatting.

Processing expectations

It is an error to include more than one <revprop> element with the same @val attribute. Recovery from this error is implementation dependent. In such cases processors MAY provide an error or warning message.

The following list outlines how processors apply @outputclass flags:

  • If one or more DITAVAL properties apply @outputclass flags to the same element, and the element already specifies one or more values for the @outputclass attribute, processors treat the element as if the tokens for the @outputclass attribute that were provided in the DITAVAL document are specified first.
  • If two or more DITAVAL properties apply @outputclass flags to the same element, processors treat the element as if each value was specified for the @outputclass attribute. The order of the tokens for the @outputclass attribute that were provided in the DITAVAL document is undefined.
Content model

<startflag> ?, <endflag> ?

Contained by

<val>

In order
  1. Optional <startflag>
  2. Optional <endflag>

Contained by

  • <val>
Attributes

The following attributes are available on this element:

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@val
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.

The following attributes are only applicable when the @action attribute is set to flag. If the @action attribute is not set to flag, any value specified for these attributes are ignored.

@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows how the <revprop> element can be used to flag content that has been marked with the @rev attribute. Elements that specify rev="edits" are rendered in red text, and glyphs mark the start and end points of the flagged revision. Alternate text is provided.

<val>
  <revprop action="flag" color="red" val="edits">
    <startflag imageref="start-glyph.png>
      <alt-text>Start of revision</alt-text>
    </startflag>
    <endflag imageref="end-glyph.png>
      <alt-text>End of revision</alt-text>
    </endflag>
  </revprop>
</val>

<startflag>

The <startflag> element in a DITAVAL document specifies information that identifies the beginning of flagged content. The information can be an image, alternate text, or both.

Usage information

If the <startflag> element does not specify an image or provide alternate text, the element has no defined purpose.

Rendering expectations

Processors treat the information provided by the <startflag> element in the following way:

  • If an image is specified, the image is used as a flag to identify the beginning of the flagged content. If the <alt-text> element contains content, the content is used as alternate text for the image.
  • If alternate text is specified but the <startflag> element does not specify an image, the alternate text is used to indicate the beginning of the flagged content.
Content model

<alt-text> ?

Contained by

<prop> , <revprop>

Optional <alt-text>

Contained by

  • <prop>
  • <revprop>
Attributes

The following attribute is available on this element:

@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a DITAVAL document that is used to render icons before content that is specific to a particular operating system. The <startflag> elements specify the icons, and the <alt-text> elements specify alternate text.

<val>
  <prop action="flag" att="platform" val="linux">
    <startflag imageref="linux-icon.gif">
      <alt-text>Linux</alt-text>
    </startflag>
  </prop>
  <prop action="flag" att="platform" val="mac">
    <startflag imageref="mac-icon.gif">
      <alt-text>Macintosh</alt-text>
    </startflag>
  </prop>
  <prop action="flag" att="platform" val="windows">
    <startflag imageref="windows-icon.gif">
      <alt-text>Windows</alt-text>
    </startflag>
  </prop>
</val>

<style-conflict>

The <style-conflict> element in a DITAVAL document declares the behavior to be used when one or more flagging methods collide on the same element..

Rendering expectations

The following table details how conflicts are resolved when different flagging methods are specified for the same element:

Flagging method Conflict behavior
backcolor

Use the color specified by the @background-conflict-color attribute on the <style-conflict> element. If no background conflict color is specified, use a default color that is appropriate for the output format.
changebar Add all change bars that apply.
color

Use the color specified by the @foreground-conflict-color attribute on the <style-conflict> element. If no foreground conflict color is specified, use a default color that is appropriate for the output format.
style Add all font styles that apply. If two different kinds of underline are used, default to the heaviest (double underline) and use the color that is specified by the @foreground-conflict-color attribute. If no foreground conflict color is specified, use a default color that is appropriate for the output format.
<endflag> Add all flags that apply.
<startflag> Add all flags that apply.
Content model

EMPTY

Contained by

<val>

Empty

Contained by

  • <val>
Attributes
The following attributes are available on this element:
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

The following code sample shows a DITAVAL document that specifies that a background color of #ffffb3 is used when there are conflicts:

<?xml version="1.0" encoding="UTF-8"?>
<val>
  <style-conflict background-conflict-color="#ffffb3"/>
  <prop action="flag" att="platform" val="dita" backcolor="#ccffb3"/>
  <prop action="flag" att="platform" val="lwdita" backcolor="#ffe6ff"/>
</val>

Any element that specifies a value of dita lwdita or lwdita dita is rendered with a light-yellow background color.

<val>

The <val> element is the root element of a DITAVAL document.

Processing expectations

For information about processing DITAVAL documents, including how to filter or flag elements with multiple property attributes or multiple properties within a single attribute, see Conditional processing.

Content model

<style-conflict> ?, ( <prop> | <revprop> )*

Not contained by any element.

In order
  1. Optional <style-conflict>
  2. Zero or more of the following
    • <prop>
    • <revprop>

Not contained by any element.

Attributes

None

@action (REQUIRED)

Specifies the action to be taken. The following values are supported:

exclude
Indicates that the content is excluded from the output, if all values for the specified attribute are excluded.
flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine.

Specifies the action to be taken. The following values are supported:

flag
Indicates that the content is included in the output and flagged, if the content has not been excluded.
include
Indicates that the content is included in the output and not flagged. This is the default behavior, unless otherwise set.
passthrough
Indicates that the content is included in the output and that the attribute value is preserved. This enables further processing by a runtime engine. The attribute value is preserved in the syntax that is required by the runtime engine.
@align
Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@appid
Specifies an ID that can be used by an application to identify the topic.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appid-role
Specifies the role that the @appid value plays for applications. The value is a single name token. The default value is context-sensitive-help. While applications can define their own values, the following values are defined by OASIS:
context-sensitive-help
Specifies that the value of the @appid attribute is used to connect the associated resource with applications that use the associated resource as context sensitive help.
deliverable-anchor
Specifies that the value of the @appid attribute is used to construct anchors for the associated resource.

When @app-role is set to deliverable-anchor, certain restrictions apply to the value of the @appid attribute. See Usage information.

@appname
Specifies a name for the external application.
@att
Specifies the conditional-processing attribute that is targeted. The value is the literal attribute name or the name of a group within one of those attributes, with the group name specified using the generalized attribute syntax. If the @att attribute is absent, then the <prop> element declares a default behavior for anything not explicitly specified in the DITAVAL document.
@author
Designates the originator of the draft comment.
@autoplay
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource automatically plays when it is presented. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@backcolor
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
Specifies the background color for flagged text. Colors can be entered by name or hex code. When images are flagged, the background color is rendered as a thick border.
@background-conflict-color
Specifies the color to be used when more than one background color applies to a single element. Colors can be entered by name or code.
@callout
Specifies the character or character string that is used for the footnote link.
@changebar
Specifies a color, style, or character to be used for rendering a change bar.
@colname
Specifies a name for the column. The <entry> element can use the @colname attribute to refer to the column.
Specifies the column name in which an entry is found. The value is a reference to the @colname attribute on the <colspec> element.
@colnum
Specifies the number of the column in the table, where 1 represents the first logical column.
@color
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
Specifies the color for flagged text. Colors can be entered by name or hex code. When images are flagged, the color is rendered as a thin border.
@cols (REQUIRED)
Specifies the number of columns in a table group.
@colspan
Specifies the number of columns that a cell is to span inside a simple table.
@colwidth
Specifies the column width. Valid values are either a proportional or fixed measure:
Proportional measure
Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.
Fixed measure
A value of a coefficient followed by a unit of measurement. The coefficients are positive integers or fixed point numbers. The fixed unit values are case-insensitive. The allowed units of measure are cm (centimeters), in (inches), pi (picas), and pt (points). The default unit of measure is pt.
If the @colwidth attribute is not specified or is empty, a proportional measure of 1* is assumed.
@content (REQUIRED)
Specifies the value for the property named in the @name attribute.
@controls
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the presentation of the resource includes user interface controls. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@data
Contains a reference to the location of an object's data. If this attribute is a relative URL, it is specified relative to the document containing the <object> element. If this attribute is set, the @type attribute should also be set.
@datakeyref
Provides a key reference to the object. When specified and the key is resolvable, the key-provided URI is used. A key that has no associated resource, only link text, is considered to be unresolved. If @data is specified, it is used as a fallback when the key cannot be resolved to a resource.
@date (REQUIRED)
Specifies the document creation date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@disposition
Specifies the status of the draft comment.
@end
Specifies an identifier that indicates the end of an index range.
@experiencelevel
Indicates the level of experience that the audience is assumed to possess. Different audiences might have different experience levels with respect to the same topic. For example, a topic might require general knowledge from a programmer but expert knowledge from a user.
@features
Provides a list of other window features, such as size, position, or scroll bars. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.
@foreground-conflict-color
Specifies the color to be used when more than one color applies to a single element. Colors can be entered by name or code.
@full-screen
Indicates whether the window is initially displayed in a maximized state. Allowable values are yes, no, and -dita-use-conref-target. The default value is no.
@headers
Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the height of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@imageref
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
Specifies a URI reference to the image, using the same syntax as the @href attribute. See The href attribute for information on supported values and processing implications.
@job
Specifies the high-level task that the audience for the content is trying to accomplish. Different audiences might read the same topic in terms of different high-level tasks. For example, a system administrator might read the topic when administering an application, while a programmer might read the same topic when customizing the application.
@keyref
Specifies a key reference to the thing the parameter references.
@kind
Specifies the usage for the track resource. This attribute is modeled on the @kind attribute on the HTML5 <track> element, as described by the HTML specification, WHATWG version. The values for this attribute are derived from the HTML5 standard:
captions
Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information. This is intended for use when the soundtrack is unavailable, for example, because it is muted or because the user is hard-of-hearing. This information is rendered over the video and labeled as appropriate for hard-of-hearing users.
chapters
Chapter titles, which are intended to be used for navigating the media resource. The chapter titles are rendered as an interactive list in the interface for the user agent.
descriptions
Textual descriptions of the video component of the media resource. This is intended for audio synthesis when the visual component is unavailable, for example, because the user is interacting with the application without a screen or because the user is blind. Descriptions are synthesized as separate audio tracks.
metadata
Tracks intended for use from script. This metadata is not displayed by the user agent.
subtitles
Transcription or translation of the dialogue, suitable for when the sound is available but not understood, for example, because the user does not understand the language of the soundtrack. Subtitles are rendered over the video.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@left
Specifies the left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@loop
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource loops when played. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@mapref
Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.
@modification
Specifies the modification level of the current version and release
@modified (REQUIRED)
Specifies the last modification date. The date is specified using the ISO 8601 format: YYYY-MM-DD, where YYYY is the year, MM is the month (01 to 12), and DD is the day (01-31).
@morerows
Specifies the number of additional rows to add in a vertical span.
@muted
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
Specifies whether the resource is muted. The following values are recognized: true, false, and -dita-use-conref-target . The default value is true.
@name
Defines a unique name for the object.
Specifies the name of the parameter.
Specifies the value used to refer to this window definition.
Specifies a name for the audience.
Specifies the name of the metadata property.
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
@nameend
Specifies the last logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@namest
Specifies the first logical column that is included in a horizontal span. The value is a reference to the @colname attribute on the <colspec> element.
@on-top
Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: yes, no, and -dita-use-conref-target. The default value is no.
@orient
Specifies the orientation of the table in page-based output formats. This attribute is primarily useful for print-oriented display. The following values are valid:
port
Indicates portrait page orientation. The page is oriented with its long side vertical and its short side horizontal.
land
Indicates landscape page orientation. The page is oriented with its long side horizontal and its short side vertical.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@outputclass
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
Specifies a value for the @outputclass attribute. The flagged element is treated as if the specified @outputclass value was specified on that element.
@pgwide
Specifies the horizontal placement of the element for print-oriented rendering. The following values are valid:
0
Aligns the element with the left margin of the current text line and takes indentation into account
1
Places the element on the left page margin
@placement
Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@relative
Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is no. The following are allowable values:
no
The window dimensions specified on this element are absolute positions; they are not relative to the calling window.
yes
The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@release
Specifies the product release identifier
@remap
Specifies information about the origins of the content within the <required-cleanup> element. This provides authors with context for determining how migrated content was originally encoded.
@rotate
Specifies whether the contents of the entry are rotated. The following values are valid:
0
Indicates that no rotation occurs.
1
Indicates that the contents of the cell are rotated 90 degrees counterclockwise.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@rowspan
Specifies the number of rows that a cell is to span inside a simple table.
@scale
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.
Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if any one of @height, @width, or @scale is specified, those attributes determine the graphic size and any setting of @scalefit is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width (whichever is more constraining).

The available width would be the prevailing column (or table cell) width—that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.

@scope
Specifies that the current entry is a header for other table entries. The following values are valid:
col
Indicates that the current entry is a header for all cells in the column.
colgroup
Indicates that the current entry is a header for all cells in the columns that are spanned by this entry.
row
Indicates that the current entry is a header for all cells in the row.
rowgroup
Indicates that the current entry is a header for all cells in the rows that are spanned by this entry.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@srclang
Specifies the language of the track resource.
@start
Specifies an identifier that indicates the start of an index range.
@style
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
Specifies the formatting to use for flagged text. This attribute can contain multiple space-delimited tokens.
@tabindex
Specifies the position of the object in tabbing order.
Specifies whether the audio resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
Specifies whether the video resource can be focused and where it participates in sequential keyboard navigation. See @tabindex in the HTML specification (WHATWG version).
@time
Specifies when the draft comment was created.
@tmclass
Specifies the classification of the trademark. This can be used to differentiate different groupings of trademarks.
@tmowner
Specifies the trademark owner, for example "OASIS".
@tmtype (REQUIRED)
Specifies the trademark type. Allowable values are:
tm
Trademark
reg
Registered trademark
service
Service mark
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@top
Specifies the top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).
@trademark
Specifies the trademarked term.
@translate-content
Indicates whether the @content attribute is translated. Allowable values are yes, no, and -dita-use-conref-target.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target
Indicates the content type (MIME type) for the data specified by the @data or @datakeyref attribute. This attribute should be set when the @data attribute is set to avoid loading unsupported content types. Note that this differs from the @type attribute on many other DITA elements (it specifies a MIME type rather than a content type). If @type is not specified, the effective type value for the key named by the @datakeyref attribute is used as the this attribute's value.
Specifies the type of audience for whom the content is intended. Note that this differs from the @type attribute on many other DITA elements.
Indicates the legal status of the copyright holder. Note that this differs from the @type attribute on many other DITA elements.
@type (REQUIRED)
Specifies the level of hazard. The values correspond to the signal words that are defined by the ANSI Z535.6 standard:
caution
Indicates a hazardous situation that, if not avoided, could result in minor or moderate injury.
danger
Indicates a hazardous situation that, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations.
notice
Indicates information considered important but not hazard-related, for example, messages relating to property damage.
warning
Indicates a hazardous situation that, if not avoided, could result in death or serious injury.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@usemap
Indicates that a client-side image map is to be used. An image map specifies active geometric regions of an included object and assigns a link to each region. When a link is selected, a document might be retrieved or a program might run on the server.
@ux-context-string
Specifies the value of a user-assistance context-string that is used to identify the topic.
@ux-source-priority

Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute is only valid when used within a <topicref> element in a map. The following values are valid:

map-only
Use IDs from the map only.
map-takes-priority
Use the IDs from the map, if they exist. Otherwise, use IDs from the topic.
topic-and-map
Use IDs from both the topic and map.
topic-only
Use IDs from the topic only.
topic-takes-priority
Use the IDs from the topic, if they exist. Otherwise, use IDs from the map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
@ux-windowref
References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.
@val
Specifies the attribute value that is targeted. If the @val attribute is absent, then the <prop> element declares a default behavior for any value in the specified attribute.
Specifies the value of the @rev attribute. If the @val attribute is not specified, then the <revprop> element declares a default behavior for any instance of the @rev attribute.
@value
Specifies the value of a run-time parameter that is described by the @name attribute.
@version (REQUIRED)
Specifies the released version number of the product
@view
Specifies the classifications of viewers that are allowed to view the document
@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Indicates the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the width of the window. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@year
Specifies the year in YYYY format
Example

This section is non-normative.

This section contains examples of DITAVAL documents and how they can be used.

Example 88. Sample DITAVAL document

The following code sample shows a DITAVAL document that excludes certain content, flags certain content, flags certain revisions, and provides a background color for when there are style conflicts:

<val>
  <style-conflict background-conflict-color="red"/>
  <prop action="exclude" att="audience" val="internal-test"/>
  <prop action="flag" att="product" val="YourProd" backcolor="purple"/>
  <prop action="flag" att="product" backcolor="blue"
        color="yellow" style="underline" val="MyProd">
    <startflag imageref="startflag.jpg">
      <alt-text>This is the start of my product info</alt-text>
    </startflag>
    <endflag imageref="endflag.jpg">
      <alt-text>This is the end of my product info</alt-text>
    </endflag>
  </prop>
  <revprop action="flag" val="1.2"/>
</val>
This sample DITAVAL document performs the following actions:
  • Elements that specify audience="internal-test" are excluded.
  • Elements that specify product="YourProd" are rendered with a background color of purple.
  • Elements with product="MyProd" get the following actions:
    • The image startflag.jpg is placed at the start of the element.
    • The image endflag.jpg is placed at the end of the element.
    • The element is rendered with a background color of blue.
    • The text in the element is rendered in yellow, and the text is underlined.
  • Elements marked with rev="1.2" are flagged with the default revision flags, which are implementation dependent.
  • When there are conflicts, for example, if an element is marked with product="MyProd YourProd", it will be flagged with a background color of red.
Example 89. DITAVAL document that overrides the default include action

The following code sample shows a DITAVAL document that sets a default value of exclude for every conditional-processing attribute. That default value is then overriden by the <prop> elements with a value of include.

<val>
  <prop action="exclude"/>
  <prop action="include" att="audience" val="everybody"/>
  <prop action="include" att="audience" val="novice"/>
  <prop action="include" att="product" val="productA"/>
  <prop action="include" att="product" val="productB"/>
</val>
This DITAVAL document performs the following actions:
  • The first <prop> element does not specify an attribute, which sets a default action of exclude for every conditional-processing attribute. This means that, by default, any property value not otherwise defined in this document evaluates to exclude. Note that this same behavior can be limited to a single attribute. The following <prop> element sets a default action of exclude for all properties specified on the @platform attribute: <prop action="exclude" att="platform"/>
  • The second and third <prop> elements set an action of include for two values on the @audience attribute. All other values on the @audience attribute still evaluate to exclude.
  • The fourth and fifth <prop> elements set an action of include for two values on the @product attribute. All other values on the @product attribute still evaluate to exclude.